编程规范与范例(2).htm

编程规范与范例。从网上收集的

            </td>
          </tr>
          <tr>
            <td width="600">〖文章转载或出处〗≡中国电子技术信息网≡ 网址：www.CETINet.com</td>  
          </tr>
          <tr>
            <td width="600">编程规范与范例(2)<br>
<br>
目&nbsp;&nbsp;录<br>
1&nbsp;排版&nbsp;6<br>
2&nbsp;注释&nbsp;11<br>
3&nbsp;标识符命名&nbsp;18<br>
4&nbsp;可读性&nbsp;20<br>
5&nbsp;变量、结构&nbsp;22<br>
6&nbsp;函数、过程&nbsp;28<br>
7&nbsp;可测性&nbsp;36<br>
8&nbsp;程序效率&nbsp;40<br>
9&nbsp;质量保证&nbsp;44<br>
10&nbsp;代码编辑、编译、审查&nbsp;50<br>
11&nbsp;代码测试、维护&nbsp;52<br>
12&nbsp;宏&nbsp;53<br>
<br>
3&nbsp;标识符命名<br>
&amp;sup1;&nbsp;3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。<br>
说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。<br>
示例：如下单词的缩写能够被大家基本认可。<br>
temp&nbsp;可缩写为&nbsp;&nbsp;tmp&nbsp;&nbsp;;<br>
flag&nbsp;可缩写为&nbsp;&nbsp;flg&nbsp;&nbsp;;<br>
statistic&nbsp;可缩写为&nbsp;&nbsp;stat&nbsp;;<br>
increment&nbsp;可缩写为&nbsp;&nbsp;inc&nbsp;&nbsp;;<br>
message&nbsp;可缩写为&nbsp;&nbsp;msg&nbsp;&nbsp;;<br>
&amp;sup1;&nbsp;3-2：命名中若使用特殊约定或缩写，则要有注释说明。<br>
说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。<br>
&amp;sup1;&nbsp;3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。<br>
说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。<br>
&amp;sup1;&nbsp;3-4：对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。<br>
说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。<br>
示例：下面所示的局部变量名的定义方法可以借鉴。<br>
int&nbsp;liv_Width<br>
其变量名解释如下：<br>
l&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;局部变量（Local）&nbsp;&nbsp;（其它：g&nbsp;&nbsp;&nbsp;&nbsp;全局变量（Global）...）<br>
i&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;数据类型（Interger）<br>
v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;变量（Variable）&nbsp;&nbsp;&nbsp;（其它：c&nbsp;&nbsp;&nbsp;&nbsp;常量（Const）...）<br>
Width&nbsp;&nbsp;变量含义<br>
这样可以防止局部变量与全局变量重名。<br>
&amp;sup1;&nbsp;3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。<br>
示例：&nbsp;Add_User不允许，add_user、AddUser、m_AddUser允许。&nbsp;<br>
&amp;frac12;&nbsp;3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。<br>
示例：如下命名，使人产生疑惑。<br>
#define&nbsp;_EXAMPLE_0_TEST_<br>
#define&nbsp;_EXAMPLE_1_TEST_<br>
void&nbsp;set_sls00(&nbsp;BYTE&nbsp;sls&nbsp;);<br>
<br>
应改为有意义的单词命名<br>
#define&nbsp;_EXAMPLE_UNIT_TEST_<br>
#define&nbsp;_EXAMPLE_ASSERT_TEST_<br>
void&nbsp;set_udt_msg_sls(&nbsp;BYTE&nbsp;sls&nbsp;);<br>
&amp;frac12;&nbsp;3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。<br>
说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。<br>
&amp;frac12;&nbsp;3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。<br>
说明：下面是一些在软件中常用的反义词组。<br>
add&nbsp;/&nbsp;remove&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;begin&nbsp;/&nbsp;end&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;create&nbsp;/&nbsp;destroy&nbsp;<br>
insert&nbsp;/&nbsp;delete&nbsp;&nbsp;&nbsp;&nbsp;first&nbsp;/&nbsp;last&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get&nbsp;/&nbsp;release<br>
increment&nbsp;/&nbsp;decrement&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;put&nbsp;/&nbsp;get<br>
add&nbsp;/&nbsp;delete&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lock&nbsp;/&nbsp;unlock&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;open&nbsp;/&nbsp;close<br>
min&nbsp;/&nbsp;max&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;old&nbsp;/&nbsp;new&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;start&nbsp;/&nbsp;stop<br>
next&nbsp;/&nbsp;previous&nbsp;&nbsp;&nbsp;&nbsp;source&nbsp;/&nbsp;target&nbsp;&nbsp;&nbsp;&nbsp;show&nbsp;/&nbsp;hide<br>
send&nbsp;/&nbsp;receive&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;source&nbsp;/&nbsp;destination<br>
cut&nbsp;/&nbsp;paste&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;up&nbsp;/&nbsp;down<br>
示例：<br>
int&nbsp;&nbsp;min_sum;<br>
int&nbsp;&nbsp;max_sum;<br>
int&nbsp;&nbsp;add_user(&nbsp;BYTE&nbsp;*user_name&nbsp;);<br>
int&nbsp;&nbsp;delete_user(&nbsp;BYTE&nbsp;*user_name&nbsp;);<br>
&amp;frac12;&nbsp;3-4：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。<br>
&nbsp;&nbsp;<br>
4&nbsp;可读性<br>
&amp;sup1;&nbsp;4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。<br>
说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。<br>
示例：下列语句中的表达式<br>
word&nbsp;=&nbsp;(high&nbsp;&lt;&lt;&nbsp;8)&nbsp;|&nbsp;low&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(1)<br>
if&nbsp;((a&nbsp;|&nbsp;b)&nbsp;&amp;&amp;&nbsp;(a&nbsp;&amp;&nbsp;c))&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(2)<br>
if&nbsp;((a&nbsp;|&nbsp;b)&nbsp;&lt;&nbsp;(c&nbsp;&amp;&nbsp;d))&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(3)<br>
如果书写为<br>
high&nbsp;&lt;&lt;&nbsp;8&nbsp;|&nbsp;low<br>
a&nbsp;|&nbsp;b&nbsp;&amp;&amp;&nbsp;a&nbsp;&amp;&nbsp;c<br>
a&nbsp;|&nbsp;b&nbsp;&lt;&nbsp;c&nbsp;&amp;&nbsp;d<br>
由于<br>
high&nbsp;&lt;&lt;&nbsp;8&nbsp;|&nbsp;low&nbsp;=&nbsp;(&nbsp;high&nbsp;&lt;&lt;&nbsp;8)&nbsp;|&nbsp;low,<br>
a&nbsp;|&nbsp;b&nbsp;&amp;&amp;&nbsp;a&nbsp;&amp;&nbsp;c&nbsp;=&nbsp;(a&nbsp;|&nbsp;b)&nbsp;&amp;&amp;&nbsp;(a&nbsp;&amp;&nbsp;c)，<br>
(1)(2)不会出错，但语句不易理解；<br>
a&nbsp;|&nbsp;b&nbsp;&lt;&nbsp;c&nbsp;&amp;&nbsp;d&nbsp;=&nbsp;a&nbsp;|&nbsp;（b&nbsp;&lt;&nbsp;c）&nbsp;&amp;&nbsp;d，(3)造成了判断条件出错。<br>
&amp;sup1;&nbsp;4-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。<br>
示例：如下的程序可读性差。<br>
if&nbsp;(Trunk[index].trunk_state&nbsp;==&nbsp;0)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;Trunk[index].trunk_state&nbsp;=&nbsp;1;<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
<br>
应改为如下形式。<br>
#define&nbsp;TRUNK_IDLE&nbsp;0<br>
#define&nbsp;TRUNK_BUSY&nbsp;1<br>
<br>
if&nbsp;(Trunk[index].trunk_state&nbsp;==&nbsp;TRUNK_IDLE)<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;Trunk[index].trunk_state&nbsp;=&nbsp;TRUNK_BUSY;<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
&amp;frac12;&nbsp;4-1：源程序中关系较为紧密的代码应尽可能相邻。<br>
说明：便于程序阅读和查找。<br>
示例：以下代码布局不太合理。<br>
rect.length&nbsp;=&nbsp;10;<br>
char_poi&nbsp;=&nbsp;str;<br>
rect.width&nbsp;=&nbsp;5;<br>
<br>
若按如下形式书写，可能更清晰一些。<br>
rect.length&nbsp;=&nbsp;10;<br>
rect.width&nbsp;=&nbsp;5;&nbsp;//&nbsp;矩形的长与宽关系较密切，放在一起。<br>
char_poi&nbsp;=&nbsp;str;<br>
&amp;frac12;&nbsp;4-2：不要使用难懂的技巧性很高的语句，除非很有必要时。<br>
说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。<br>
示例：如下表达式，考虑不周就可能出问题，也较难理解。<br>
*&nbsp;stat_poi&nbsp;++&nbsp;+=&nbsp;1;<br>
<br>
*&nbsp;++&nbsp;stat_poi&nbsp;+=&nbsp;1;<br>
<br>
应分别改为如下。<br>
*stat_poi&nbsp;+=&nbsp;1;<br>
stat_poi++;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;此二语句功能相当于“&nbsp;*&nbsp;stat_poi&nbsp;++&nbsp;+=&nbsp;1;&nbsp;”<br>
<br>
++&nbsp;stat_poi;<br>
*stat_poi&nbsp;+=&nbsp;1;&nbsp;//&nbsp;此二语句功能相当于“&nbsp;*&nbsp;++&nbsp;stat_poi&nbsp;+=&nbsp;1;&nbsp;”<br>
5&nbsp;变量、结构<br>
&amp;sup1;&nbsp;5-1：去掉没必要的公共变量。<br>
说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间的耦合度。<br>
&amp;sup1;&nbsp;5-2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。<br>
说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要还应说明与其它变量的关系。<br>
&amp;sup1;&nbsp;5-3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。<br>
说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。<br>
示例：在源文件中，可按如下注释形式说明。<br>
RELATION&nbsp;&nbsp;&nbsp;&nbsp;System_Init&nbsp;&nbsp;&nbsp;&nbsp;Input_Rec&nbsp;&nbsp;&nbsp;&nbsp;Print_Rec&nbsp;&nbsp;&nbsp;Stat_Score<br>
Student&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Modify&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Access&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Access<br>
Score&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Modify&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Access&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Access,&nbsp;Modify<br>
<br>
注：RELATION为操作关系；System_Init、Input_Rec、Print_Rec、Stat_Score为四个不同的函数；Student、Score为两个全局变量；Create表示创建，Modify表示修改，Access表示访问。<br>
其中，函数Input_Rec、Stat_Score都可修改变量Score，故此变量将引起函数间较大的耦合，并可能增加代码测试、维护的难度。<br>
&amp;sup1;&nbsp;5-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。<br>
说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。<br>
&amp;sup1;&nbsp;5-5：防止局部变量与公共变量同名。<br>
说明：若使用了较好的命名规则，那么此问题可自动消除。<br>
&amp;sup1;&nbsp;5-6：严禁使用未经初始化的变量作为右值。<br>
说明：特别是在C/C++中引用未经赋值的指针，经常会引起系统崩溃。<br>
&amp;frac12;&nbsp;5-1：构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。<br>
说明：降低公共变量耦合度。<br>
&amp;frac12;&nbsp;5-2：使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密切的变量。<br>
说明：使用标准的数据类型，有利于程序的移植。<br>
示例：如下例子（在DOS下BC3.1环境中），在移植时可能产生问题。<br>
void&nbsp;main()<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;register&nbsp;int&nbsp;index;&nbsp;//&nbsp;寄存器变量<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;_AX&nbsp;=&nbsp;0x4000;&nbsp;//&nbsp;_AX是BC3.1提供的寄存器“伪变量”<br>
&nbsp;&nbsp;&nbsp;&nbsp;...&nbsp;//&nbsp;program&nbsp;code<br>
}<br>
&amp;frac12;&nbsp;5-3：结构的功能要单一，是针对一种事务的抽象。<br>
说明：设计结构时应力争使结构代表一种现实事务的抽象，而不是同时代表多种。结构中的各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。<br>
示例：如下结构不太清晰、合理。<br>
typedef&nbsp;struct&nbsp;STUDENT_STRU<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;char&nbsp;name[8];&nbsp;/*&nbsp;student's&nbsp;name&nbsp;*/<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;char&nbsp;age;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;student's&nbsp;age&nbsp;*/<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;char&nbsp;sex;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;student's&nbsp;sex,&nbsp;as&nbsp;follows&nbsp;*/<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;0&nbsp;-&nbsp;FEMALE;&nbsp;1&nbsp;-&nbsp;MALE&nbsp;*/<br>
&nbsp;&nbsp;&nbsp;&nbsp;unsigned&nbsp;char&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;teacher_name[8];&nbsp;/*&nbsp;the&nbsp;student&nbsp;teacher's&nbsp;name&nbsp;*/<br>
&nbsp;&nbsp;&nbsp;&nbsp;unisgned&nbsp;char&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;teacher_sex;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;his&nbsp;teacher&nbsp;sex&nbsp;*/<br>
}&nbsp;STUDENT;<br>
<br>
若改为如下，可能更合理些。<br>