代码规范

代码规范

要求

• 容易看懂
• 看项目结构就知道写作的思路
• 在代码中找东西很方便。
• 团队写出来的就像是一个人写出来的。

关注点

• 编码风格
  • 命名使用驼峰还是下划线；缩进使用空格还是tab;一行代码的最大长度等等。
• 命名规范
  • 是否使用能够让人“望文生义”，解释代码的功能
• 功能性
  • 是否完成了项目所要求的所有功能。
• 测试覆盖
  • 各个单元是否都有合适的测试代码。
• 复杂性
  • 度量代码复杂度，防止代码复杂度过大。
• 良好注释
• 设计框架
  • 是否好维护，易拓展
• 安全性
  • 数据安全性
  • 运行安全性

具体内容

命名风格

• 不用下划线和美元符号开头。
• 类名使用大驼峰
• 方法名（函数名）参数名，成员变量，局部变量使用统一的小驼峰风格，禁止使用拼音命名。
• 对于过长的单词使用不规范的缩写，需要熟悉常用的规范缩写。(一般是去掉元音字母)
• 常量使用全大写，单词之间使用下划线分割。
• 包名同一使用小写
• 长整型需要使用大写的L,作为后缀名。
• 可穷举的变量，可以考虑使用枚举变量。

代码格式

• 禁止使用tab,使用4个空格缩进
• 单行字符限制不超过120个
• 换行符使用unix格式。
• 运算符左右两边各使用两个空格。
• 保留字（关键字）和括号之间都必须有空格。
• 多个参数逗号之后要加空格。

注释

• 类/方法
• 单行注释，使用// 在需要被注释的语句上方单起一行。
• 不需要的代码，要去掉，可以通过代码管理软件进行版本的管理。

安全性

• 安全性低
  • 数据容易泄露（级别低的用户会访问到其他数据）
  • 程序运行异常
  • 资源消耗异常。