编程规范(程序员必看).docVIP

编程规范（程序员必看） 1.基本要求 1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。1.3 尽量使用标准库函数和公共函数。1.4 不要随意定义全局变量，尽量使用局部变量。1.5 使用括号以避免二义性。 2.可读性要求2.1 可读性第一，效率第二。2.2 保持注释与代码完全一致。2.3 每个源程序文件，都有文件头说明，说明规格见规范。2.4 每个函数，都有函数头说明，说明规格见规范。2.5 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。2.7 常量定义（DEFINE）有相应说明。2.8 处理过程的每个阶段都有相关注释说明。2.9 在典型算法前都有注释。2.10 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 6个字节。2.11 循环、分支层次不要超过五层。2.12 注释可以与语句在同一行，也可以在上行。2.13 空行和空白字符也是一种特殊注释。2.14 一目了然的语句不加注释。2.15 注释的作用范围可以为：定义、引用、条件分支以及一段代码。2.16 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。3. 结构化要求3.1 禁止出现两条等价的支路。3.2 禁止GOTO语句。3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。3.4 用 CASE 实现多路分支。3.5 避免从循环引出多个出口。3.6 函数只有一个出口。3.7 不使用条件赋值语句。3.8 避免不必要的分支。3.9 不要轻易用条件分支去替换逻辑表达式。4. 正确性与容错性要求4.1 程序首先是正确，其次是优美4.2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。4.3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4.4 所有变量在调用前必须被初始化。4.5 对所有的用户输入，必须进行合法性检查。 4.6 不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ， 不可靠4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。4.8 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。5. 可重用性要求5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。5.2 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。5.3 公共控件或类应建立使用模板。附：C＋＋ 编程规范,delphi作相应的参考 .1适用范围本标准适用于利用Visul C++ ,Borland C++进行软件程序开发的人员.。.2变量命名命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,可都大写.如OK.具体例程:BOOL类型 bEnable;ch * char chTextc * 类对象 cMain（对象实例）h * Handle（句柄） hWndi * intn * 无符号整型p * 指针sz,str * 字符串w WORDx,y 坐标Char或者TCHAR类型 与Windows API有直接联系的用szAppName[10]形式否则用FileName[10]形式,单个字符也可用小写字母表示;Int类型 nCmdShow;LONG类型 lParam;UINT类型 uNotify; DWORD类型 dwStart;PSTR类型 pszTip;LPSTR类型 lpCmdLineLPTSTR类型 lpszClassName;LPVOID类型 lpReservedWPARAM类型 wParam,LPARAM类型 lParamHWND类型 hDlg;HDC类型 hDC;HINSTANCE类型 hInstanceHANDLE类型 hInstance,HICON类型 hIcon;int iTmpfloat fTmpDWORD dw*String , AnsiString str *m_ 类成员变量 m_nVal, m_bFlagg_ 全局变量 g_nMsg, g_bFlag局部变量中可采用如下几个通用变量：nTemp，nResult，I，J（一般用于循环变量）。其他资源句柄同上.3常量命名和宏定义常量和宏定义必须具有一定的实际意义;常量