编程规范
版权和版本声明
内容:
- 版权信息。
- 文件名称,标识符,摘要。
- 当前版本号,作者/修改者,完成日期。
- 版本历史信息。
/**
* Copyright ……
* All rights reserved.
*
* 文件名称:
* 文件标识:
* 摘要:
*
* 当前版本:
* 作者:
* 完成日期:
*
* 取代版本:
* 原作者:
* 完成日期:
*/
版式
空行
- 每个类声明之后,每个函数定义之后都要加入空行。
- 函数体内,逻辑密切相关的不添加空行,其他地方应添加空行。
代码行
- 一行代码一件事情。这样方便阅读和注释。
- if,for,while,do占一行。
- 尽可能在定义变量时初始化变量。
行内空格
- 关键字后需要添加至少一个空格。
- 函数名后紧跟’('不能有空格。
- ',‘之后要留空格。如果’;'不是行的结尾,那么就要添加空格。
- 二元操作符前后都要添加空格。
- 一元操作符前后不能添加空格。
对齐
- ‘{’,’}‘对齐。’{‘放在行尾或单独一行。’}‘与’{‘对齐或者’{'所在行的代码开头。
长行拆分
- 一行长度在70~80字符。过长就要分行。
- 在低优先级的符号前分行,使低优先级操作符放于新行行首。
注释
- 行注释使用 //
- 块注释使用 /**/
- 注释应放在临近的地方,放于上方或右方。
类版式
- private类型数据写在前面。
- public类型的函数写在前面。
命名规则
- 驼峰命名法。
- 变量名 = 形容词 + 名词 = 动词 + 名词
- 常量全用大写字母