源代码编写规范.doc

源代码编写规范 (V1.0) 二○一○年一月 目录 一． 概述 3 二． 规范内容: 4 3.1 源代码标注规范（for C++）: 4 3.1.1 缩写规则 4 3.1.2 命名规则 4 3.1.3 语句构造规则 8 3.1.4 书写格式规则 9 3.1.5 注释规则 9 3.2 源代码标注规范（for ASP） 12 3.2.1 编码约定概述 12 3.2.2 常数命名规则 12 3.2.3 变量命名规则 12 3.2.4 变量作用域 13 3.2.5 变量作用域前缀 13 3.2.6 描述性变量名和过程名 13 3.2.7 对象命名规则 13 3.2.8 代码注释约定 14 3.2.9 格式化代码 15 3.3 源代码标注规范（for Java） 17 3.3.1 命名规范 17 3.3.2 Java文件的样式规则 18 3.3.3 代码编写格式 21 3.3.4 Swing 25 3.3.5 调试 25 3.3.6 性能 25 3.3.7 可移植性 26  概述 编写目的 为了健全公司软件源代码的管理，增加源代码的可读性，提高软件开发效率，特编写些规范。此规范并非源代码编写的一个标准，而是作为一个参考，以培养开发人员良好的编程习惯。 范围 开发时源代码的命名、注释规范（包括ASP，C/C++，JAVA）。  规范内容: 源代码标注规范（for C++）: 缩写规则 缩写后一个单词的长度宜为3-6个字母。 缩写后应能辨认出原意。 尽量使用公认的缩写习惯，如：Window缩写为Win; SmartPoint缩写为sp。 命名规则 使用含义鲜明、描述性的英文单词或缩写命名；命名由字母、数字和下划线构成，一般情况下不得超过32个字符；命名建议采用组合词的方式。 变量命名规则 一般性规则：由单词(第一个单词或其缩写字母全部小写，以后单词首字母大写，其余的字母小写)构成名词词组，如：int nValue; CString strTemp; CListCtrl listUserInfo;第一个单词(前缀)的缩写格式原则上以匈牙利命名方式为准（参见表一:匈牙利命名法），并且原则上不建议用下划线作为单词间的连接符： 表一：匈牙利命名法 前缀 类型 描述 实例 arr Array 静态数组 arrPoint b BOOL 布尔值 bEnabled by unsigned char(BYTE) 8位无符号字符 byWeek ch Char 8位字符 chGrade tch TCHAR 如果是_UNICODE，为16位字符 tchName i/n Int 整形（其大小依赖于操作系统） iRange u UINT 无符号整形（其大小依赖于操作系统） nLength us unsigned short 无符号短整形 usPort w WORD 16位无符号值 wParam l LONG 32位有符号整形 loffset dw DWORD 32位无符号整形 dwVolume f Float 4字节浮点数 fHigh d Double 8字节浮点数 dAmount cy CURRENCY 8字节货币类型 cySell p * 指针 pDoc lp FAR * 远指针 lpDoc lpsz LPSTR 为32位字符串指针 lpszName lpcsz LPCSTR 32位常量字符串指针 lpcszName lpctsz LPCTSTR 如果_UNICODE定义，为32位常量字符串指针 lpctszName bstr BSTR 带有4字节长度前缀的w_chart数组 bstrMessage pbstr BSTR* BSTR数据类型指针 pbstrMsg str String CString类型的字符串 strMessage och OLECHAR OLECHAR字符类型 ochX osz OLECHAR* OLECHAR字符串类型 oszX var VARIANT VARIANT数据类型 var pvar VARIANT* VARIANT数据类型指针 pvar sa SAFEARRAY SAFEARRAY数据类型 sa psa SAFEARRAY* SAFEARRAY数据类型指针 psa dlg CDialog Windows对话框 dlg stc CStatic Windows静态文本控件 stc edt Cedit Windows编辑框控件 edt lsb CListBox Windows列表控件 lsb btn CButton Windows按钮控件 btn scb CScrollBar Windows滚动条控件