# Front-End-Standards

**Repository Path**: sunshine824/Front-End-Standards

## Basic Information

- **Project Name**: Front-End-Standards
- **Description**: 前端规范文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2021-04-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">做一个有原则的前端程序猿</h1>

## 前言

良好的代码规范，在团队开发中是必不可少的，它可以让代码看起简洁清晰减少 bug 的出现，还可以让新加入的成员更快的上手项目，更能够让看代码的人赏心悦目。以下是我根据平时开发总结的编码规范，让我们做一个有原则的是前端程序猿！！！！！！！！！

## 团队注意事项（切记！切记！切记！）

1、开发过程中控制台遇错改错（尽量处理所有报错输出）  
2、功能调试通过后必须删除所有测试代码，比如console.log  
3、model框必须抽离成独立的组件  
4、每次代码pull之后，必须重启项目，确保一切正常之后方可push，commit的时候必须描述清楚提交信息。  
5、注释尽量写全乎，具体到人头上，格式如下
```
  /**
  * @description: 中文说明
  * @author: name
  * @update: name(xxxx-xx-xx)
  * @param {string} a - 参数a
  */
```


## 目录

1. [CSS 规范](https://github.com/sunshine824/Front-End-Standards/blob/master/Css-Guide.md)
2. [JS 规范](https://github.com/sunshine824/Front-End-Standards/blob/master/Js-Guide.md)
3. [VUE 规范](https://github.com/sunshine824/Front-End-Standards/blob/master/Vue-Guide.md)