结对同学:代秋彤
要求一:《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
我们目前制定的代码规范分为三部分:版式要求,注释要求,命名规则。
具体条款如下:
一. 版式要求:
- 尽量使用标准库函数和公共函数。
- 每个函数都有函数头说明。
- 利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位。
- 每个函数定义结束后加空行。
- 关键字后要加空格,如“if”后应留空格再加左括号;函数名后要紧跟左括号,与关键字进行区别。
- If、for、while、do等语句自占一行。
- 一行代码只做一件事情,如只定一个变量或只写一条语句。
- 程序中“{”和“}”应独占一行并且位于同一列。
- “{ }”之内的代码块在“{”右边数格处左对齐。
二. 注释要求:
- 注释要简洁明了,注释的花样要少。
- 注释可以与语句在同一行,也可以在上行。
- 边写代码边注释,修改代码同时修改相应的注释,保证注释与代码的一致性。
- 主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
三. 命名规则:
- 变量和参数用大写字母开头的单词组合而成。
- 常量全用大写的字母,用下划线分割单词。
执行和违反情况:
1.通过调整做到缩进标准,逻辑结构清晰:
2.修改后保证空行正确:
3.修改后做到关键字后加空格,函数名后要紧跟左括号,与关键字进行区别:
4.修改后做到If、for、while、do等语句自占一行:
5.修改后保证一行代码只做一件事情
6.修改后保证程序中“{”和“}”独占一行并且位于同一列,且“{ }”之内的代码块在“{”右边数格处左对齐:
7.注释部分经过修改达到全部4点要求,做到简洁易懂:
8.命名遵循规范,详情见代码。