第8章编码精要.pptVIP

(14) 对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case 语句处理完、下一个case语句前加上明确的注释。这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。 (15) 维护代码时，要更新相应的注释，删除不再有用的注释。保持代码、注释的一致性，避免产生误解。 8.5.2 注释 (1) 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词采用大家公认的缩写。 (2) 命名中若使用特殊约定或缩写，则要有注释说明。 (3) 自己特有的命名风格，要自始至终保持一致，不可来回变化。 8.5.3 标识符命名 (4) 对于变量命名，建议除了要有具体含义外，还能表明其变量类型、数据类型等，因此最好不要用单个字符表示，如果用单个字符表示，很容易敲错，而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。但使用单个字符表示局部循环变量是允许的（如i, j, k）。 (5) 命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排（如add_user或AddUser）的方式，不要使用大小写与下划线混排（如Add_User）的方式。 8.5.3 标识符命名 (1) 注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。这是为了防止阅读程序时产生误解。 例如，本来是正确的代码： If ( year % 4 == 0 || year % 100 != 0 year % 400 == 0 ) 如果加上括号，则更清晰。 If ((year % 4) == 0 || ((year % 100) != 0 (year % 400) == 0)) 8.5.4 可读性 (2) 避免使用不易理解的数字，用有意义的标识来替代。 涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。 8.5.4 可读性 (1) 去掉没必要的公共变量，以降低模块间的耦合度。 (2) 仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。 (3) 明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。这将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。 (4) 当向公共变量传递数据时，要十分小心，若有必要应进行合法性检查，防止赋与不合理的值或越界等现象发生。 (5) 防止局部变量与公共变量同名。 (6) 严禁使用未经初始化的变量。特别是在C／C++中引用未经赋值的指针，经常会引起系统崩溃。 8.5.5 变量 (1) 每个函数完成单一的功能，不设计多用途面面俱到的函数。 (2) 函数和过程中关系较为紧密的代码尽可能相邻。如初始化代码应放在一起，不应在中间插入实现其它功能的代码。 (3) 对所调用函数的错误返回码要仔细、全面地处理。 (4) 每个函数的源程序行数原则上应该少于200行。 对于消息分流处理函数，完成的功能统一，但由于消息的种类多，可能超过200行的限制，不属于违反规定。 8.5.6 函数 (5) 编写可重入函数时，应注意局部变量的使用（如编写C／C++语言的可重入函数时，应使用auto即缺省态局部变量或寄存器变量），不应使用static局部变量，否则必须经过特殊处理，才能使函数具有可重入性。 (6) 编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。若对所使用的全局变量不加以保护，则此函数就不具有可重入性，即当多个进程调用此函数时，很有可能使有关全局变量为不可知状态。 (7) 避免函数中不必要的语句，防止程序中的垃圾代码，预留代码应以注释的方式出现。 8.5.6 函数 (1) 在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明。 (2) 在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）和行号，以便于集成测试。 (3) 编程的同时要为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明。测试代码部分应作为（模块中的）一个子模块，以方便测试代码在模块中的安装与拆卸（通过调测开关） 8.5.7 可测试性 (4) 在进行集成测试／系统联调之前，要构造好测试环境、测试项目及测试用例，同时仔细分析并优化测试用例，以提高测试效率。好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一