摘要:
5.1 谨慎使用全局(公共)变量 (1)去掉没必要的公共变量。公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。 (2)仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要还应说明与其 阅读全文
摘要:
4.1使用有意义的标识,避免直接使用数字 避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。 示例:如下的程序可读性差。 if (Trunk[index].trunk_state == 0) { Trunk[index] 阅读全文
摘要:
3.1 命名的基本原则 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解——尽量采用采用英文单词或全部中文全拼表示 3.2 变量名的命名规则 (1)变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型,其余部分用变量的英文意思、英文的缩写、中文 阅读全文
摘要:
2.1 注释的原则 注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例:如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息。 /* i 阅读全文
摘要:
1.1 严格采用阶梯层次组织程序代码 各层次缩进的风格采用TAB缩进(TAB宽度原则上使用系统默认值) 1.2空行 (1)变量说明之后必须加空行。 (2)相对独立的程序块之间应加空行。 1.3 对变量的定义,尽量位于函数的开始位置 (1)应避免分散定义变量。 (2)同一类的变量在同一行内定义,或者在 阅读全文
摘要:
编程规范概要 1、 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。 2、 打算干什么,要简单,直截了当,代码精简,避免垃圾程序。 3、 尽量使用标准库函数和公共函数。 4、 不要随意定义全局变量,尽量使用局部变量。 5、 使用括号以避免二义性。 可读性要求 1、可读性第一,效率第二。 阅读全文