📄 编程规范与范例(1).htm
字号:
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD><STRONG><FONT color=#ff0000>广告（2号位）</FONT></STRONG></TD></TR>
<TR bgColor=#ffffff>
<TD>
<DIV align=center>
<ADDRESS> <A href="http://www.3gmcu.com/" target=_blank><IMG style="BORDER-LEFT-COLOR: #000000; BORDER-BOTTOM-COLOR: #000000; BORDER-TOP-COLOR: #000000; BORDER-RIGHT-COLOR: #000000" src="http://blog.21ic.org/uploadfile-/2005122820932375.gif" border=0></A></ADDRESS></DIV></TD></TR></TBODY></TABLE></P>
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD><STRONG><FONT color=#ff0000>酷贴推荐 <FONT color=#ff0000>[</FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=7437" target=_blank><U><FONT color=#ff0000>更多…… </FONT></U></A><FONT color=#ff0000>]</FONT></FONT></STRONG></TD></TR>
<TR bgColor=#ffffff>
<TD>
<P align=left>
<TABLE borderColor=#cccccc cellSpacing=2 cellPadding=3 width="100%" bgColor=#ffffff border=1>
<TBODY>
<TR>
<TD>
<P align=center> [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=16591"><U><FONT style="BACKGROUND-COLOR: #ffff00" color=#ff0000>岁月如歌——记匠人的百宝箱博客开通一周年</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=17379"><U><FONT color=#0000ff>事件驅動觀念</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=17377"><U><FONT color=#0000ff>单片机程序设计中运用事件驱动机制</FONT></U></A>]</P></TD>
<TR>
<TD>
<P align=center>[<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18941"><U><FONT color=#0000ff>计算机族必喝的健康饮料</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18714"><U><FONT color=#0000ff>男人·女人·电脑</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18713"><U><FONT color=#0000ff>学编程的人不能不看的好文章</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=18742"><U><FONT color=#0000ff>PIC机与MCS-51的区别</FONT></U></A>]</P></TD>
<TR>
<TD>
<P align=center>[<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19794"><U><FONT color=#0000ff>一种软件去除键抖动的方法</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19752"><U><FONT color=#0000ff>司马光，你干嘛砸缸？</FONT></U></A>] [<A href="http://blog.21ic.com/more.asp?name=cxjr&id=19748"><U><FONT color=#0000ff>编码规范</FONT></U></A>] </P></TD>
<TR>
<TD>
<P align=center><FONT color=#ff0000>调查：[</FONT><A href="http://21icbbs.com/club/vote/showvote.asp?id=98" target=_blank><U><FONT color=#ff0000>您认为《匠人的百宝箱》如何？</FONT></U></A><FONT color=#ff0000>] [</FONT><A href="http://21icbbs.com/club/vote/showvote.asp?id=129" target=_blank><U><FONT color=#ff0000>您最喜欢《匠人的百宝箱》中哪个栏目？</FONT></U></A><FONT color=#ff0000>] [</FONT><A href="http://blog.21ic.com/more.asp?name=cxjr&id=18993"><U><FONT color=#ff0000>请网友来评选最佳队员专栏</FONT></U></A><FONT color=#ff0000>]</FONT> </P></TD></TR></TBODY></TABLE></P></TD></TR></TBODY></TABLE></P>
<P align=left>
<TABLE style="TABLE-LAYOUT: fixed; WORD-BREAK: break-all" cellSpacing=1 cellPadding=3 width="100%" bgColor=#cccccc border=0>
<TBODY>
<TR bgColor=#f8f8f8>
<TD>
<P align=left><FONT color=#ff0000 size=4><STRONG><img src=images/face/1.gif ><a href=blog.asp?name=cxjr&subjectid=66>[编程技巧]<a href=more.asp?name=cxjr&id=2754>编程规范与范例(1)</a></STRONG></FONT><BR>程序匠人 2005-8-27 20:14:00 <a href=more.asp?name=cxjr&id=2754>阅读全文(1414)</a> | <a href=more.asp?name=cxjr&id=2754#comment>回复(0)</a> | <a href=showtb.asp?id=2754 target=_blank>引用(0)</a><BR><FONT face=宋体 size=4><STRONG>[</STRONG></FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=6250" target=_blank><FONT face=宋体 color=#ff0000 size=4><STRONG>广告8号位</STRONG></FONT></A><FONT face=宋体 size=4><STRONG>] [</STRONG></FONT><A href="http://blog.21ic.org/more.asp?name=cxjr&id=7705"><U><FONT style="BACKGROUND-COLOR: #000000" face=宋体 color=#ffffff size=4><STRONG>免责声明</STRONG></FONT></U></A><FONT face=宋体 size=4><STRONG>] [</STRONG><A href="http://blog.21ic.com/more.asp?name=cxjr&id=18993"><U><FONT style="BACKGROUND-COLOR: #ffff00" color=#ff0000 size=3><STRONG>请网友来评选最佳队员专栏！</STRONG></FONT></U></A><STRONG>]</STRONG></FONT></P></TD></TR>
<TR bgColor=#ffffff>
<TD height=0>
<DIV align=left><P>编程规范与范例(1) <BR>〖文章转载或出处〗≡中国电子技术信息网≡ 网址：<A href="http://www.CETINet.com">www.CETINet.com</A> <BR>编程规范与范例(1)</P>
<P>目 录<BR>1 排版 6<BR>2 注释 11<BR>3 标识符命名 18<BR>4 可读性 20<BR>5 变量、结构 22<BR>6 函数、过程 28<BR>7 可测性 36<BR>8 程序效率 40<BR>9 质量保证 44<BR>10 代码编辑、编译、审查 50<BR>11 代码测试、维护 52<BR>12 宏 53<BR> <BR>1 排版<BR>&sup1; 1-1：程序块要采用缩进风格编写，缩进的空格数为4个。<BR>说明：对于由开发工具自动生成的代码可以有不一致。<BR>&sup1; 1-2：相对独立的程序块之间、变量说明之后必须加空行。<BR>示例：如下例子不符合规范。<BR>if (!valid_ni(ni))<BR>{<BR> ... // program code<BR>}<BR>repssn_ind = ssn_data[index].repssn_index;<BR>repssn_ni = ssn_data[index].ni;</P>
<P>应如下书写<BR>if (!valid_ni(ni))<BR>{<BR> ... // program code<BR>}</P>
<P>repssn_ind = ssn_data[index].repssn_index;<BR>repssn_ni = ssn_data[index].ni;<BR>&sup1; 1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。<BR>示例：<BR>perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN<BR> + STAT_SIZE_PER_FRAM * sizeof( _UL );</P>
<P>act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied<BR> = stat_poi[index].occupied;</P>
<P>act_task_table[taskno].duration_true_or_false<BR> = SYS_get_sccp_statistic_state( stat_item );</P>
<P>report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)<BR> && (n7stat_stat_item_valid (stat_item))<BR> && (act_task_table[taskno].result_data != 0));<BR> <BR>&sup1; 1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。<BR>示例：<BR>if ((taskno < max_act_task_number)<BR> && (n7stat_stat_item_valid (stat_item)))<BR>{<BR> ... // program code<BR>}</P>
<P>for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)<BR> && (j < NewKeyword.word_length); i++, j++)<BR>{<BR> ... // program code<BR>}</P>
<P>for (i = 0, j = 0; <BR> (i < first_word_length) && (j < second_word_length); <BR> i++, j++)<BR>{<BR> ... // program code <BR>}<BR>&sup1; 1-5：若函数或过程中的参数较长，则要进行适当的划分。<BR>示例：<BR>n7stat_str_compare((BYTE *) & stat_object,<BR> (BYTE *) & (act_task_table[taskno].stat_object),<BR> sizeof (_STAT_OBJECT));</P>
<P>n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER<BR> + index, stat_object );<BR>&sup1; 1-6：不允许把多个短语句写在一行中，即一行只写一条语句。<BR>示例：如下例子不符合规范。<BR>rect.length = 0; rect.width = 0;</P>
<P>应如下书写<BR>rect.length = 0;<BR>rect.width = 0;<BR>&sup1; 1-7：if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 <BR>示例：如下例子不符合规范。<BR>if (pUserCR == NULL) return;</P>
<P>应如下书写：<BR>if (pUserCR == NULL)<BR>{<BR> return;<BR>}<BR>&sup1; 1-8：对齐只使用空格键，不使用TAB键。<BR>说明：以免用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐，不要使用BC作为编辑器合版本，因为BC会自动将8个空格变为一个TAB键，因此使用BC合入的版本大多会将缩进变乱。<BR>&sup1; 1-9：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。<BR>&sup1; 1-10：程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。<BR>示例：如下例子不符合规范。<BR>for (...) {<BR> ... // program code<BR>}</P>
<P>if (...) <BR> {<BR> ... // program code<BR> }</P>
<P>void example_fun( void )<BR> {<BR> ... // program code<BR> }</P>
<P>应如下书写。<BR>for (...) <BR>{<BR> ... // program code<BR>}</P>
<P>if (...) <BR>{<BR> ... // program code<BR>}</P>
<P>void example_fun( void )<BR>{<BR> ... // program code<BR>}<BR>&sup1; 1-11：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。<BR>说明：采用这种松散方式编写代码的目的是使代码更加清晰。<BR>由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。<BR>在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。</P>
<P>示例：<BR>(1) 逗号、分号只在后面加空格。<BR>int a, b, c; </P>
<P>(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。<BR>if (current_time >= MAX_TIME_VALUE) <BR>a = b + c;<BR>a *= 2;<BR>a = b ^ 2;</P>
<P>(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。<BR>*p = 'a'; // 内容操作"*"与内容之间<BR>flag = !isEmpty; // 非操作"!"与内容之间<BR>p = &mem; // 地址操作"&" 与内容之间<BR>i++; // "++","--"与内容之间</P>
<P>(4)"->"、"."前后不加空格。<BR>p->id = pid; // "->"指针前后不加空格</P>
<P>(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。<BR>if (a >= b && c > d)<BR>&frac12; 1-1：一行程序以小于80字符为宜，不要写得过长。<BR> <BR>2 注释<BR>&sup1; 2-1：一般情况下，源程序有效注释量必须在20％以上。<BR>说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。<BR>&sup1; 2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。<BR>示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<BR>/*************************************************<BR> Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.<BR> File name: // 文件名<BR> Author: Version: Date: // 作者、版本及完成日期<BR> Description: // 用于详细说明此程序文件完成的主要功能，与其他模块<BR> // 或函数的接口，输出值、取值范围、含义及参数间的控<BR> // 制、顺序、独立或依赖等关系<BR> Others: // 其它内容的说明<BR> Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明<BR> 1. ....<BR> History: // 修改历史记录列表，每条修改记录应包括修改日期、修改<BR> // 者及修改内容简述 <BR> 1. Date:<BR> Author:<BR> Modification:<BR> 2. ...<BR>*************************************************/<BR>&sup1; 2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。<BR>示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<BR>/************************************************************<BR> Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.<BR> FileName: test.cpp<BR> Author: Version : Date:<BR> Description: // 模块描述 <BR> Version: // 版本信息<BR> Function List: // 主要函数及其功能<BR> 1. -------<BR> History: // 历史修改记录<BR> <author> <time> <version > <desc><BR> David 96/10/12 1.0 build this moudle <BR>***********************************************************/<BR>说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。<BR>&sup1; 2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。<BR>示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。<BR>/*************************************************<BR> Function: // 函数名称<BR> Description: // 函数功能、性能等的描述<BR> Calls: // 被本函数调用的函数清单<BR> Called By: // 调用本函数的函数清单<BR> Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）<BR> Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）<BR> Input: // 输入参数说明，包括每个参数的作<BR> // 用、取值说明及参数间关系。<BR> Output: // 对输出参数的说明。<BR> Return: // 函数返回值的说明<BR> Others: // 其它说明<BR>*************************************************/<BR>&sup1; 2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。<BR>&sup1; 2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。<BR>说明：错误的注释不但无益反而有害。<BR>规则2-7：避免在注释中使用缩写，特别是非常用缩写。<BR>说明：在使用缩写时或之前，应对缩写进行必要的说明。<BR>&sup1; 2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。<BR>示例：如下例子不符合规范。<BR>例1：<BR>/* get replicate sub system index and net indicator */</P>
<P><BR>repssn_ind = ssn_data[index].repssn_index;<BR>repssn_ni = ssn_data[index].ni;</P>
<P>例2：<BR>repssn_ind = ssn_data[index].repssn_index;<BR>repssn_ni = ssn_data[index].ni;<BR>/* get replicate sub system index and net indicator */</P>
<P>应如下书写<BR>/* get replicate sub system index and net indicator */<BR>repssn_ind = ssn_data[index].repssn_index;<BR>repssn_ni = ssn_data[index].ni;<BR>&sup1; 2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。<BR>示例：<BR>/* active statistic task number */<BR>#define MAX_ACT_TASK_NUMBER 1000</P>
<P>#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */<BR>&sup1; 2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。<BR>示例：可按如下形式说明枚举/数据/联合结构。<BR>/* sccp interface with sccp user primitive message name */<BR>enum SCCP_USER_PRIMITIVE<BR>{<BR> N_UNITDATA_IND, /* sccp notify sccp user unit data come */<BR> N_NOTICE_IND, /* sccp notify user the No.7 network can not */<BR> /* transmission this message */<BR> N_UNITDATA_REQ, /* sccp user's unit data transmission request*/<BR>};<BR>&sup1; 2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。<BR>示例：<BR>/* The ErrorCode when SCCP translate */<BR>/* Global Title failure, as follows */ // 变量作用、含义<BR>/* 0 － SUCCESS 1 － GT Table error */<BR>/* 2 － GT error Others － no use */ // 变量取值范围<BR>/* only function SCCPTranslate() in */<BR>/* this modual can modify it, and other */<BR>/* module can visit it through call */<BR>/* the function GetGTTransErrorCode() */ // 使用方法<BR>BYTE g_GTTranErrorCode; <BR>&sup1; 2-12：注释与所描述内容进行同样的缩排。<BR>说明：可使程序排版整齐，并方便注释的阅读与理解。<BR>示例：如下例子，排版不整齐，阅读稍感不方便。<BR>void example_fun( void )<BR>{<BR>/* code one comments */<BR> CodeBlock One</P>
<P> /* code two comments */<BR> CodeBlock Two<BR>}</P>
<P>应改为如下布局。<BR>void example_fun( void )<BR>{<BR> /* code one comments */<BR> CodeBlock One</P>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -