📄 编程规范与范例(4).htm
字号:
<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=2757>编程规范与范例(4)</a></STRONG></FONT><BR>程序匠人 2005-8-27 20:17:00 <a href=more.asp?name=cxjr&id=2757>阅读全文(720)</a> | <a href=more.asp?name=cxjr&id=2757#comment>回复(0)</a> | <a href=showtb.asp?id=2757 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>编程规范与范例(4) <BR>〖文章转载或出处〗≡中国电子技术信息网≡ 网址：<A href="http://www.CETINet.com">www.CETINet.com</A> <BR>编程规范与范例(4)</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>7 可测性<BR>&sup1; 7-1：在同一项目组或产品组内，要有一套统一的为集成测试与系统联调准备的调测开关及相应打印函数，并且要有详细的说明。<BR>说明：本规则是针对项目组或产品组的。<BR>&sup1; 7-2：在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号。<BR>说明：统一的调测信息格式便于集成测试。<BR>&sup1; 7-3：编程的同时要为单元测试选择恰当的测试点，并仔细构造测试代码、测试用例，同时给出明确的注释说明。测试代码部分应作为（模块中的）一个子模块，以方便测试代码在模块中的安装与拆卸（通过调测开关）。<BR>说明：为单元测试而准备。<BR>&sup1; 7-4：在进行集成测试/系统联调之前，要构造好测试环境、测试项目及测试用例，同时仔细分析并优化测试用例，以提高测试效率。<BR>说明：好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况等。<BR>&sup1; 7-5：使用断言来发现软件问题，提高代码可测性。<BR>说明：断言是对某种假设条件进行检查（可理解为若条件成立则无动作，否则应报告），它可以快速发现并定位软件问题，同时对系统错误进行自动报警。断言可以对在系统中隐藏很深，用其它手段极难发现的问题进行定位，从而缩短软件问题定位时间，提高系统的可测性。实际应用时，可根据具体情况灵活地设计断言。<BR>示例：下面是C语言中的一个断言，用宏来设计的。（其中NULL为0L）<BR>#ifdef _EXAM_ASSERT_TEST_ // 若使用断言测试</P>
<P>void exam_assert( char * file_name, unsigned int line_no )<BR>{<BR> printf( "\n[EXAM]Assert failed: %s, line %u\n", <BR> file_name, line_no );<BR> abort( );<BR>}</P>
<P>#define EXAM_ASSERT( condition )<BR> if (condition) // 若条件成立，则无动作<BR> NULL;<BR> else // 否则报告<BR> exam_assert( __FILE__, __LINE__ ) </P>
<P>#else // 若不使用断言测试</P>
<P>#define EXAM_ASSERT(condition) NULL </P>
<P>#endif /* end of ASSERT */<BR>&sup1; 7-6：用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。<BR>&sup1; 7-7：不能用断言来检查最终产品肯定会出现且必须处理的错误情况。<BR>说明：断言是用来处理不应该发生的错误情况的，对于可能会发生的且必须处理的情况要写防错程序，而不是断言。如某模块收到其它模块或链路上的消息后，要对消息的合理性进行检查，此过程为正常的错误检查，不能用断言来实现。<BR>&sup1; 7-8：对较复杂的断言加上明确的注释。<BR>说明：为复杂的断言加注释，可澄清断言含义并减少不必要的误用。<BR>&sup1; 7-9：用断言确认函数的参数。<BR>示例：假设某函数参数中有一个指针，那么使用指针前可对它检查，如下。<BR>int exam_fun( unsigned char *str )<BR>{<BR> EXAM_ASSERT( str != NULL ); // 用断言检查“假设指针不为空”这个条件<BR> <BR> ... //other program code<BR>}<BR>&sup1; 7-10：用断言保证没有定义的特性或功能不被使用。<BR>示例：假设某通信模块在设计时，准备提供“无连接”和“连接” 这两种业务。但当前的版本中仅实现了“无连接”业务，且在此版本的正式发行版中，用户（上层模块）不应产生“连接”业务的请求，那么在测试时可用断言检查用户是否使用“连接”业务。如下。<BR>#define EXAM_CONNECTIONLESS 0 // 无连接业务<BR>#define EXAM_CONNECTION 1 // 连接业务</P>
<P>int msg_process( EXAM_MESSAGE *msg )<BR>{<BR> unsigned char service; /* message service class */</P>
<P> EXAM_ASSERT( msg != NULL );</P>
<P>service = get_msg_service_class( msg );</P>
<P> EXAM_ASSERT( service != EXAM_CONNECTION ); // 假设不使用连接业务</P>
<P> ... //other program code<BR>}<BR>&sup1; 7-11：用断言对程序开发环境（OS/Compiler/Hardware）的假设进行检查。<BR>说明：程序运行时所需的软硬件环境及配置要求，不能用断言来检查，而必须由一段专门代码处理。用断言仅可对程序开发环境中的假设及所配置的某版本软硬件是否具有某种功能的假设进行检查。如某网卡是否在系统运行环境中配置了，应由程序中正式代码来检查；而此网卡是否具有某设想的功能，则可由断言来检查。<BR>对编译器提供的功能及特性假设可用断言检查，原因是软件最终产品（即运行代码或机器码）与编译器已没有任何直接关系，即软件运行过程中（注意不是编译过程中）不会也不应该对编译器的功能提出任何需求。<BR>示例：用断言检查编译器的int型数据占用的内存空间是否为2，如下。<BR>EXAM_ASSERT( sizeof( int ) == 2 );<BR>&sup1; 7-12：正式软件产品中应把断言及其它调测代码去掉（即把有关的调测开关关掉）。<BR>说明：加快软件运行速度。<BR>&sup1; 7-13：在软件系统中设置与取消有关测试手段，不能对软件实现的功能等产生影响。<BR>说明：即有测试代码的软件和关掉测试代码的软件，在功能行为上应一致。<BR>&sup1; 7-14：用调测开关来切换软件的DEBUG版和正式版，而不要同时存在正式版本和DEBUG版本的不同源文件，以减少维护的难度。<BR>&sup1; 7-15：软件的DEBUG版本和发行版本应该统一维护，不允许分家，并且要时刻注意保证两个版本在实现功能上的一致性。<BR>&frac12; 7-1：在编写代码之前，应预先设计好程序调试与测试的方法和手段，并设计好各种调测开关及相应测试代码如打印函数等。<BR>说明：程序的调试与测试是软件生存周期中很重要的一个阶段，如何对软件进行较全面、高率的测试并尽可能地找出软件中的错误就成为很关键的问题。因此在编写源代码之前，除了要有一套比较完善的测试计划外，还应设计出一系列代码测试手段，为单元测试、集成测试及系统联调提供方便。<BR>&frac12; 7-2：调测开关应分为不同级别和类型。<BR>说明：调测开关的设置及分类应从以下几方面考虑：针对模块或系统某部分代码的调测；针对模块或系统某功能的调测；出于某种其它目的，如对性能、容量等的测试。这样做便于软件功能的调测，并且便于模块的单元测试、系统联调等。<BR>&frac12; 7-3：编写防错程序，然后在处理错误之后可用断言宣布发生错误。<BR>示例：假如某模块收到通信链路上的消息，则应对消息的合法性进行检查，若消息类别不是通信协议中规定的，则应进行出错处理，之后可用断言报告，如下例。<BR>#ifdef _EXAM_ASSERT_TEST_ // 若使用断言测试</P>
<P>/* Notice: this function does not call 'abort' to exit program */<BR>void assert_report( char * file_name, unsigned int line_no )<BR>{<BR> printf( "\n[EXAM]Error Report: %s, line %u\n", <BR> file_name, line_no );<BR>}</P>
<P>#define ASSERT_REPORT( condition ) <BR> if ( condition ) // 若条件成立，则无动作<BR> NULL;<BR> else // 否则报告<BR> assert_report ( __FILE__, __LINE__ ) </P>
<P>#else // 若不使用断言测试</P>
<P>#define ASSERT_REPORT( condition ) NULL </P>
<P>#endif /* end of ASSERT */</P>
<P>int msg_handle( unsigned char msg_name, unsigned char * msg )<BR>{<BR> switch( msg_name )<BR> {<BR> case MSG_ONE:<BR> ... // 消息MSG_ONE处理<BR> return MSG_HANDLE_SUCCESS;<BR> <BR> ... // 其它合法消息处理<BR> <BR> default:<BR> ... // 消息出错处理<BR> ASSERT_REPORT( FALSE ); // “合法”消息不成立，报告<BR> return MSG_HANDLE_ERROR;<BR> }<BR>} <BR>8 程序效率<BR>&sup1; 8-1：编程时要经常注意代码的效率。<BR>说明：代码效率分为全局效率、局部效率、时间效率及空间效率。全局效率是站在整个系统的角度上的系统效率；局部效率是站在模块或函数角度上的效率；时间效率是程序处理输入任务所需的时间长短；空间效率是程序所需内存空间，如机器代码空间大小、数据空间大小、栈空间大小等。<BR>&sup1; 8-2：在保证软件系统的正确性、稳定性、可读性及可测性的前提下，提高代码效率。<BR>说明：不能一味地追求代码效率，而对软件的正确性、稳定性、可读性及可测性造成影响。<BR>&sup1; 8-3：局部效率应为全局效率服务，不能因为提高局部效率而对全局效率造成影响。<BR>&sup1; 8-4：通过对系统数据结构的划分与组织的改进，以及对程序算法的优化来提高空间效率。<BR>说明：这种方式是解决软件空间效率的根本办法。<BR>示例：如下记录学生学习成绩的结构不合理。<BR>typedef unsigned char BYTE;<BR>typedef unsigned short WORD;</P>
<P>typedef struct STUDENT_SCORE_STRU</P>
<P><BR> BYTE name[8];<BR> BYTE age;<BR> BYTE sex;<BR> BYTE class;<BR> BYTE subject;<BR> float score;<BR>} STUDENT_SCORE;</P>
<P>因为每位学生都有多科学习成绩，故如上结构将占用较大空间。应如下改进（分为两个结构），总的存贮空间将变小，操作也变得更方便。<BR>typedef struct STUDENT_STRU<BR>{<BR> BYTE name[8];<BR> BYTE age;<BR> BYTE sex;<BR> BYTE class;<BR>} STUDENT;</P>
<P>typedef struct STUDENT_SCORE_STRU<BR>{<BR> WORD student_index;<BR> BYTE subject;<BR> float score;<BR>} STUDENT_SCORE;<BR>&sup1; 8-5：循环体内工作量最小化。<BR>说明：应仔细考虑循环体内的语句是否可以放在循环体之外，使循环体内工作量最小，从而提高程序的时间效率。<BR>示例：如下代码效率不高。<BR>for (ind = 0; ind < MAX_ADD_NUMBER; ind++)<BR>{<BR> sum += ind;<BR> back_sum = sum; /* backup sum */<BR>}</P>
<P>语句“back_sum = sum;”完全可以放在for语句之后，如下。<BR>for (ind = 0; ind < MAX_ADD_NUMBER; ind++)<BR>{<BR> sum += ind;<BR>}<BR>back_sum = sum; /* backup sum */<BR>&frac12; 8-1：仔细分析有关算法，并进行优化。<BR>&frac12; 8-2：仔细考查、分析系统及模块处理输入（如事务、消息等）的方式，并加以改进。<BR>&frac12; 8-3：对模块中函数的划分及组织方式进行分析、优化，改进模块中函数的组织结构，提高程序效率。<BR>说明：软件系统的效率主要与算法、处理任务方式、系统功能及函数结构有很大关系，仅在代码上下功夫一般不能解决根本问题。<BR>&frac12; 8-4：编程时，要随时留心代码效率；优化代码时，要考虑周全。<BR>&frac12; 8-5：不应花过多的时间拼命地提高调用不很频繁的函数代码效率。<BR>说明：对代码优化可提高效率，但若考虑不周很有可能引起严重后果。<BR>&frac12; 8-6：要仔细地构造或直接用汇编编写调用频繁或性能要求极高的函数。<BR>说明：只有对编译系统产生机器码的方式以及硬件系统较为熟悉时，才可使用汇编嵌入方式。嵌入汇编可提高时间及空间效率，但也存在一定风险。<BR>&frac12; 8-7：在保证程序质量的前提下，通过压缩代码量、去掉不必要代码以及减少不必要的局部和全局变量，来提高空间效率。<BR>说明：这种方式对提高空间效率可起到一定作用，但往往不能解决根本问题。<BR>&frac12; 8-8：在多重循环中，应将最忙的循环放在最内层。<BR>说明：减少CPU切入循环层的次数。<BR>示例：如下代码效率不高。<BR>for (row = 0; row < 100; row++)<BR>{<BR> for (col = 0; col < 5; col++)<BR> {<BR> sum += a[row][col];<BR> }<BR>}</P>
<P>可以改为如下方式，以提高效率。<BR>for (col = 0; col < 5; col++)<BR>{<BR> for (row = 0; row < 100; row++)<BR> {<BR> sum += a[row][col];<BR> }<BR>}<BR>&frac12; 8-9：尽量减少循环嵌套层次。<BR>&frac12; 8-10：避免循环体内含判断语句，应将循环语句置于判断语句的代码块之中。<BR>说明：目的是减少判断次数。循环体中的判断语句是否可以移到循环体外，要视程序的具体情况而言，一般情况，与循环变量无关的判断语句可以移到循环体外，而有关的则不可以。<BR>示例：如下代码效率稍低。<BR>for (ind = 0; ind < MAX_RECT_NUMBER; ind++)<BR>{<BR> if (data_type == RECT_AREA)<BR> {<BR> area_sum += rect_area[ind];<BR> }<BR> else<BR> {<BR> rect_length_sum += rect[ind].length;<BR> rect_width_sum += rect[ind].width;<BR> }<BR>}</P>
<P>因为判断语句与循环变量无关，故可如下改进，以减少判断次数。<BR>if (data_type == RECT_AREA)<BR>{<BR> for (ind = 0; ind < MAX_RECT_NUMBER; ind++)<BR> {<BR> area_sum += rect_area[ind];<BR> }<BR>}<BR>else<BR>{<BR> for (ind = 0; ind < MAX_RECT_NUMBER; ind++)<BR> {<BR> rect_length_sum += rect[ind].length;<BR> rect_width_sum += rect[ind].width;<BR> }<BR>}<BR>&frac12; 8-11：尽量用乘法或其它方法代替除法，特别是浮点运算中的除法。<BR>说明：浮点运算除法要占用较多CPU资源。<BR>示例：如下表达式运算可能要占较多CPU资源。<BR>#define PAI 3.1416<BR>radius = circle_length / (2 * PAI);</P>
<P>应如下把浮点除法改为浮点乘法。<BR>#define PAI_RECIPROCAL (1 / 3.1416 ) // 编译器编译时，将生成具体浮点数<BR>radius = circle_length * PAI_RECIPROCAL / 2; <BR>&frac12; 8-12：不要一味追求紧凑的代码。<BR>说明：因为紧凑的代码并不代表高效的机器码。 <BR> <BR><A></A></P></DIV></TD></TR></TBODY></TABLE><FONT color=#ff0000></FONT>
<P align=right><A href="http://blog.21ic.org/blog.asp?name=cxjr" target=_blank><FONT color=#ff0000>如果你的‘芯’是一座作坊，我愿做那不知疲倦的程序匠。打造一流博客，我们每天在努力！</FONT></A></P><A href="http://blog.21ic.org/blog.asp?name=cxjr" target=_blank><FONT color=#ff0000></FONT></A><br><a name='comment'></a><table width='90%' border='0' align='center' cellspacing='0' cellpadding='0'> <tr> <td><strong>发表评论：</strong></tr></td></table>
<table width='90%' border='0' align='center' cellspacing='0' cellpadding='0'> <tr> <td><table align='left' width='100%' border='0' cellspacing='0' cellpadding='0'>
<form action='more.asp?name=cxjr&id=2757&action=addcomment_ic' method='post' name='commentform' onSubmit='return Verifycomment()'>
<tr><td height='25' align='left'>昵称：<input name='UserName' type='text' id='UserName' size='15' maxlength='20' value=''></td></tr>
<tr><td height='25' align='left'>密码：<input name='Password' type='password' id='Password' size='15' maxlength='20' value=''> (游客无须输入密码)</td></tr>
<tr ><td height='25' align='left' >验证码：<input name='GetCode' type='text' id='GetCode' size='12' maxlength='20' /> <img src='inc/code.asp' width='40' height='10' border='0' /><td></tr><tr ><td height='25' align='left' >主页：<input name='homepage' type='text' id='homepage' size='42' maxlength='50' value='http://'><td></tr><tr ><td height='25' align='left' >标题：<input name='commenttopic' type='text' id='commenttopic' size='42' maxlength='50' value='回复:编程规范与范例(4)'><td></tr><tr height='200'><td ><INPUT type='hidden' name='edit' id='edit' value=''>
<link rel="STYLESHEET" type="text/css" href="images/edit.css">
<Script Src="images/DhtmlEdit.js"></Script>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -