这是我参与「第五届青训营 」伴学笔记创作活动的第 15 天.
规范
- 命名
骆驼式命名法(CamelCase),又称之为小驼峰式命名法(LowerCamelCase),混合使用大小写字母,即多个单词的情况下,第一个单词首字母小写,其余单词首字母均大写。方法名一般采用动词+名词或动词表示,如 append()、getName()、printStackTrace() 等。代码中代码严禁拼音和英文混合的方式,更不允许直接用纯中文标识。常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。文件名以“模块+功能”的描述方式进行命名。
- 规范代码格式
单行单语句,一行不超过一个语句:不允许把多个短语句写在一行中,即一行只写一条语句。语句的拆分: 函数或过程中的参数较长,循环、判断等语句中有较长的表达式或语句,要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读
- 注释规范 必要性:在代码的功能、意图层次上注释,解释代码的目的、功能和采用的方法,提供代码外的信息,帮助理解,已经清楚的语句就不要重复注释。自注释:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构。及时性和准确性: 边写代码边注释,改了代码也要改注释,不用的注释要删除。注释的量:一般源程序有效注释量必须在20%以上。必须是有助于对程序的理解,准确易懂、清楚无二义性、简洁明了。
- 空格 运算符和等号两边习惯各加一个空格。每层代码缩进4个字符(tab),整体有层次感。