专业化的程式设计之Coding Rules谈

　　前言：

　　要开发出专业化的软件产品，在编码阶段，必须严格贯彻一定的代码开发准则，这会减少程式的隐含错误，同时使程式的内部结构清晰。从而开发出少错误、易维护的优质程式，使得程式的团队合作性和专业化程度大为提高。这是软件开发中公认的一个准则，也是软件工程在编码阶段的一个具体的应用。我曾与不少编程的朋友讨论过这个问题，在实际的开发中也积累了一些心得，现在我将我所体会到的Coding Rule整理于下：

　　内容：

   　　适用平台为32位Windows，语言为以C++为基础的语言（C++,VC++...） 　

　　一．提高程序的可读性要求：

　　　1．对你所写的每一个文件都加上相关的标准化注释，一般应包括：文件的作用、版本号信息、作者及时间等。

　　　2．为你定义的类写详细的注释，包括作者、时间、版本修订信息、基本的算法、以及成员变量的详细解释等。

　　　3．为你定义的每一个函数写详细的注释，包括输入输出参数说明、返回值说明、函数功能说明。

　　　********************************************************************************

　　　4．在函数的内部，长条注释（划分功能模块）、短条注释（说明实现的各步骤）与句后解释（说明重要句的意义）相结合，清晰功能的实现层次。

　　　file://*************下面实现如下功能 *****************

　　　file://进行...操作（1）。

　　　..............

　　　.............. 　file://此操作作用为...。

　　　file://进行...操作（2）。

　　　5．所有命名（类、函数、变量..）均要求意义明确易于理解。

　　　6．避免在代码中直接使用数字和TRUE/FALSE等不确定意义的词，尽量使用有意义的串值代替。

　　　　　　const static WORD W_PERSON_NUM = 10;
　　　　　　BOOL bMustProcess = TRUE;

　　　7．最好不要出现向“if(test)等”逻辑判断语句，用以下代替：

　　　　　　if( TRUE == test)
　　　　　　　if( PersonNum == test)
　　　　　　　　if(NULL ！= test).

　　　8．不要使用goto。

　　　9．不要写太长的if（）{...},for(){...},While(...){}或者太多的嵌套。

　　　10．对上述较长者在范围结束处加注释。如//for 循环结束

　　　11．在名字上区分各种变量及函数

　　　　　类成员变量：m_*，全局变量：g_*，API函数：::。