代码规范

Posted 2020-12-22 021700613h

代码规范

• 缩进

  1. 程序块要采用缩进风格编写，缩进的空格数为 4 个。

  2. 缩进或者对齐只能使用空格键，不可使用 TAB 键。

     使用 TAB 键需要设置 TAB 键的空格数目是 4 格。

• 变量命名

  1. 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

     反例： _name / __name / $Object / name_ / name$ / Object$
     

  2. 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

     说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。
     注意，即使纯拼音命名方式也要避免采用。

     反例： DaZhePromotion [打折] / getPingfenByName()  [评分] / int某变量 = 3
     正例： alibaba / taobao / youku / hangzhou等国际通用的名称，可视同英文。
     

• 每行最多字符数

  1. 语句(>80 字符)要分成多行书写。

• 函数最大行数

  1. 函数最大行数不超过100行

• 函数、类命名

  1. 类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。

     正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal /   TaPromotion
     反例：macroPolo / UserDo / XMLService / TCPUDPDeal /   TAPromotion
     

  2. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。

      正例： localValue / getHttpMessage() /  inputUserId
     

  3. 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。

• 常量

  1. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

     正例： MAX_STOCK_COUNT
     反例： MAX_COUNT
     

• 空行规则

  1. 函数之间应该用空行分开。
  2. 变量声明应尽可能靠近第一次使用处，避免一次性声明一组没有马上使用的变量。
  3. 用空行将代码按照逻辑片断划分。
  4. 每个类声明之后应该加入空格同其他代码分开。

• 注释规则

  1. 源文件头部应进行注释，列出:生成日期、作者、模块目的/功能等。
  2. 函数头部应进行注释，列出:函数的目的/功能、输入参数、输出参数、返回 值等。
  3. 注释应该和代码同时更新，不再有用的注释要删除。

• 操作符前后空格

  1. 关键字之后要留空格。象 const、virtual、inline、case 等关键字之后至少要留一个空格， 否则无法辨析关键字。象 if、for、while 等关键字之后应留一个空格再跟左括号‘( ’， 以突出关键字。
  2. 函数名之后不要留空格， 紧跟左括号’(’ ， 以与关键字区别。
  3. ‘（‘向后紧跟，‘）‘、‘，‘、‘;‘向前紧跟，紧跟处不留空格。
  4. ‘，‘之后要留空格，如Function(x, y, z)。如果‘;‘不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。
  5. 值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“ =”、“ +=”、“ >=”、“ <=”、“ +”、“ *”、“ %”、“ &&”、“ ||”、“ <<” 、“ ^” 等二元操作符 的前后应当加空格。
  6. 一元操作符如“ !”、“ ~”、“ ++”、“ --”、“ &”( 地址运算符) 等前后不加 空格。
  7. 象“[ ]”、“ .”、“ ->” 这类操作符前后不加空格。

• 其他规则

  1. 中括号是数组类型的一部分，数组定义如下：String[] args;

     反例：请勿使用String  args[]的方式来定义。
     

  2. POJO类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。

     反例：定义为基本数据类型boolean isSuccess；的属性，
     它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异
     常。
     

  3. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

     正例：应用工具类包名为com.alibaba.open.util、类名为MessageUtils（此规则参考spring的框架结构）
     

  4. 杜绝完全不规范的缩写，避免望文不知义。

     反例： AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
     

参考

[1] 《码出高效_阿里巴巴Java开发手册》
[2] 《腾讯c++代码规范》