编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册

编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册

ID:6620082

大小:33.00 KB

页数:10页

时间:2018-01-20

编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册_第1页
编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册_第2页
编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册_第3页
编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册_第4页
编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册_第5页
资源描述:

《编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、编程规范-程序员们都应该这样写代码-程序员-编程初学者必备手册1.1程序结构清析,简单易懂,单个函数的程序行数不得超过100行。1.2打算干什么,要简单,直接了当,代码精简,避免垃圾程序。1.3尽量使用标准库函数和公共函数。1.4不要随意定义全局变量,尽量使用局部变量。1.5使用括号以避免二义性。2.可读性要求2.1可读性第一,效率第二。2.2保持注释与代码完全一致。2.3每个源程序文件,都有文件头说明,说明规格见规范。2.4每个函数,都有函数头说明,说明规格见规范。2.5主要变量(结构、联合、类或对象)定义或引用时,注

2、释能反映其含义。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、3.1禁止出现两条等价的支路。3.2禁止GOTO语句。3.3用IF语句来强调只执行两组语句中的一组。禁止ELSEGOTO和ELSERETURN。3.4用CASE实现多路分支。3.5避免从循环引出多个出口。3.6函数只有一个出口。3.7不使用条件赋值语句。3.8避免不必要的分支。3.9不要轻易用条件分支去替换逻辑表达式。4.正确性与容错性要求4.1程序首先是正确,其次是优美4.2无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。4.3改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。4.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作

5、相应的参考.1适用范围本标准适用于利用VisulC++,BorlandC++进行软件程序开发的人员.。.2变量命名命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,可都大写.如OK.具体例程:BOOL类型bEnable;ch*charchTextc*类对象cMain(对象实例)h*Handle(句柄)hWndi*intn*无符号整型p*指针sz,str*字符串wWORDx,y坐标Char或者TCHAR类型与WindowsAPI有直接联系的用sz

6、AppName[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类

7、型hIcon;intiTmpfloatfTmpDWORDdw*String,AnsiStringstr*m_类成员变量m_nVal,m_bFlagg_全局变量g_nMsg,g_bFlag局部变量中可采用如下几个通用变量:nTemp,nResult,I,J(一般用于循环变量)。其他资源句柄同上.3常量命名和宏定义常量和宏定义必须具有一定的实际意义;常量和宏定义在#include和函数定义之间;常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用;资源名字定

8、义格式:菜单:IDM_XX或者CM_XX位图:IDB_XX对话框:IDD_XX字符串:IDS_XXDLGINIT:DIALOG_XXICON:IDR_XX.4函数命名函数原型说明包括引用外来函数及内部函数,外部引用必须在右侧注明函数来源:模块名及文件名,如是内部函数,只要注释其定义文件名;第一个字母必须使用大写字母,

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。