肉联帮前端代码规范要点概述

JavaScript、CSS、HTML、GIT和Markdown等代码在肉联帮团队前端代码规范中得到详细和说明。这些规范和格式要求是确保代码质量和团队合作效率的基础。

1. JavaScript

• 变量命名：

  • 使用小驼峰命名法，例如userName和userAge。
  • 避免使用下划线和连字符，例如user_name和user-name。
  • 变量名应具有性，并避免使用缩写和晦涩的术语。

• 函数命名：

  • 使用帕斯卡命名法，例如getUserName和setUserAge。
  • 避免使用下划线和连字符，例如get_user_name和set_user_age。
  • 函数名应具有描述性，并避免使用缩写和晦涩的术语。

• 代码风格：

  • 使用4个空格进行缩进，不要使用制表符。
  • 使用分号分隔语句，不要使用逗号。
  • 使用花括号将代码块分组，即使只有一行代码。
  • 使用注释来解释代码，但不要过度注释。

2. CSS

• 选择器命名：

  • 使用小写字母和连字符，例如.user-name和.user-age。
  • 避免使用下划线和缩写，例如#user_name和.ua。
  • 选择器名应具有描述性，并避免使用通用的名称。

• 属性命名：

  • 使用小写字母和连字符，例如background-color和font-size。
  • 避免使用下划线和缩写，例如background_color和fs。
  • 属性名应具有描述性，并避免使用通用的名称。

• 代码风格：

  • 使用4个空格进行缩进，不要使用制表符。
  • 使用分号分隔语句，不要使用逗号。
  • 使用花括号将代码块分组，即使只有一行代码。
  • 使用注释来解释代码，但不要过度注释。

3. HTML

• 元素命名：

  • 使用小写字母和连字符，例如<div>和<p>.
  • 避免使用下划线和缩写，例如<div_id>和<p_class>.
  • 元素名应具有描述性，并避免使用通用的名称。

• 属性命名：

  • 使用小写字母和连字符，例如id和class。
  • 避免使用下划线和缩写，例如id_user和class_user.
  • 属性名应具有描述性，并避免使用通用的名称。

• 代码风格：

  • 使用4个空格进行缩进，不要使用制表符。
  • 使用分号分隔语句，不要使用逗号。
  • 使用花括号将代码块分组，即使只有一行代码。
  • 使用注释来解释代码，但不要过度注释。

4. GIT

• 分支命名：

  • 使用小写字母和连字符，例如feature/new-feature和bugfix/fix-bug.
  • 避免使用下划线和缩写，例如feature_new_feature和bugfix_fix_bug.
  • 分支名应具有描述性，并避免使用通用的名称。

• 提交信息：

  • 使用祈使语态，例如“添加新功能”和“修复错误”。
  • 使用简明扼要的语言，并避免使用冗长的句子。
  • 使用换行符来分隔不同的提交信息。

• 代码风格：

  • 使用4个空格进行缩进，不要使用制表符。
  • 使用分号分隔语句，不要使用逗号。
  • 使用花括号将代码块分组，即使只有一行代码。
  • 使用注释来解释代码，但不要过度注释。

5. Markdown

• ** - 使用#号加空格的方式来创建标题，例如“# 一级标题”和“## 二级标题”。

  • 一级标题应使用一个#号，二级标题应使用两个#号，以此类推。
  • 标题应具有描述性，并避免使用通用的名称。

• 列表：

  • 使用短横线、加号或星号来创建列表，例如“- 一级列表项”和“+ 二级列表项”。
  • 一级列表项应使用一个短横线、加号或星号，二级列表项应使用两个短横线、加号或星号，以此类推。
  • 列表项应具有描述性，并避免使用通用的名称。

• 代码块：

  • 使用三个反引号来创建代码块，例如```javascript
    function add(a, b) {
    return a + b;
    }

  - 代码块应具有描述性，并避免使用通用的名称。

遵循这些规范和格式要求，可以帮助肉联帮团队的前端开发人员保持代码质量和团队合作效率，并为持续的代码改进提供坚实的基础。