2021秋软工实践第一次个人编程作业代码规范制定

作业其它部分链接

• Github 仓库
• 博客部分

代码规范制定

• 缩进

  • 缩进采用 4 个空格，如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格

• 变量命名

  • 不以下划线或美元符号开始，也不以下划线或美元符号结束
  • 不使用拼音与英文混合的方式或直接使用中文的方式
  • 成员变量、局部变量都统一使用 lowerCamelCase 风格

• 每行最多字符数

  • 单行字符数限制不超过 120个

• 方法最大行数

  • 80 行

• 方法、类命名

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

• 常量

  • 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚

• 空行规则

  • 不同的方法之间插入空行
  • 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行

• 注释规则

  • 使用中文注释，把问题说清楚。专有名词与关键字保持英文原文
  • 注释力求精简准确、表达到位

• 操作符前后空格

  • 操作符左右要加一个空格

• 其他规则

  • 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格
  • 左大括号前不换行，后换行；右大括号前换行，后还有 else 等代码则不换行，而表示终止后必须换行
  • if / for / while / switch / do 等保留字与左右括号之间都必须加空格