本学期代码规范
本学期代码规范
参考企业:腾讯。
程序的版式:
- 程序块要采用缩进风格编写:程序块要采用缩进风格编写,缩进的空格数为,缩进的空格数为4个。
- 缩进或者对齐只能使用空格键:缩进或者对齐只能使用空格键,不可使用TAB 键。(使用TAB键需要设置 TAB 键的空格数目是4格。)
- 相对独立的程序块之间、变量说明之后必须加空行。说明:函数之间,每个类声明之后,逻辑片段要用空行分隔。变量声明应尽可能靠近第一次使用处,避免一次性声明一组没有马上使用的变量。
- 不允许把多个短语句写在一行中,即一行只写一条语句。
- if、for、do、while、case、switch、default 等语句自占一行,且 if、for、do、while 等语句的执行语句部分无论多少都要加括号 {}。
- 代码行之内应该留有适当的空格,如:关键字之后要留空格,函数名之后不要留空格,左括号后要紧跟右括号。
- 程序块的分界符 :程序块的分界符(如 C/C++语言的大括号‘{’和‘}’)应各独占一行并且 应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩 语句中的程序都要采用如上的缩进方式。
- 函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值等。
- 注释应该和代码同时更新,不再有用的注释要删除。
- 注释的主要目的应该是解释为什么这么做,而不是正在做什么。如果从上下文不容易看出作者的目的,说明程序的可读性本身存在比较大的问题 ,应考虑对其重构。
- 分支语句(条件分支、循环语句等)需编写注释。
- 常量、宏和模板名采用全大写的方式 ,每个单词间用下划线分隔。
- 枚举类型 enum 常量应以大写字母开头或全部大写。
- 命名中若使用了特殊约定或缩写,则要有注释说明。
剩下的没咋看懂,估计本学期也用不到。
ps:由于两个作业只能交一个链接,我把《数学之美》读后感的链接放在这里: