代码规范文档.docVIP

目录 1 编程风格 1 1.1 统一编程风格的意义 1 1.2 变量命名的规则 1 1.3 函数的命名规范 3 1.4 函数参数规范 3 1.5 引出函数规范 4 1.6注释规范 4 2 代码组织 5 3 代码优化 6 3.1 代码优化的意义 6 3.2代码优化的方法 6 4 调试技巧 7 4.1静态检查 7 4.2 上机调试 7 4.3 C语言常见问题 8 1 编程风格 1.1 统一编程风格的意义 增加开发过程代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编程所需的脑力工作 为软件的良好维护性打下好的基础 在项目范围内统一代码风格 通过人为以及自动的方式对最终软件应用质量标准 使新的开发人员快速适应项目氛围 支持项目资源的复用：允许开发人员从一个项目区域（或子项目团队）移动到另一个，而不需要重新适应新的子项目团队的氛围 一个优秀而且职业化的开发团队所必需的素质 1.2 变量命名的规则 ①变量的命名规则要求用“匈牙利法则”。即开头字母用变量的类型，其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。即：???? 变量名=变量类型+变量的英文意思（或缩写）????????对非通用的变量，在定义时加入注释说明，变量定义尽量可能放在函数的开始处。?????见下表：?????bool(BOOL)???? 用b开头???? bIsParent?????byte(BYTE)???? 用by开头???? byFlag?????short(int)???? 用n开头???? nStepCount?????long(LONG)???? 用l开头???? lSum?????char(CHAR)???? 用c开头???? cCount?????float(FLOAT)???? 用f开头???? fAvg?????double(DOUBLE)???? 用d开头???? dDeta?????void(VOID)???? 用v开头???? vVariant?????unsigned???? int（WORD）???? 用w开头???? wCount?????unsigned???? long(DWORD)???? 用dw开头???? dwBroad?????HANDLE（HINSTANCE）???? 用h开头???? hHandle?????DWORD???? 用dw开头???? dwWord?????LPCSTR(LPCTSTR)???? 用str开头???? strString?????用0结尾的字符串???? 用sz开头???? szFileName?????对未给出的变量类型要求提出并给出命名建议给技术委员会。?????、指针变量命名的基本原则为：?????对一重指针变量的基本原则为：?????“p”+变量类型前缀+命名?????如一个float*型应该表示为pfStat???对多重指针变量的基本规则为：?????二重指针：???? “pp”+变量类型前缀+命名?????三重指针：???? “ppp”+变量类型前缀+命名???? ③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即：变量名=g_+变量类型+变量的英文意思（或缩写）???? ④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即：???? 变量名=s_+变量类型+变量的英文意思（或缩写）??? ⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即：变量名=m_+变量类型+变量的英文意思（或缩写）?????? ⑥、对枚举类型（enum）中的变量，要求用枚举变量或其缩写做前缀。并且要求用大写。????如：enum???? cmEMDAYS???????? {??????? EMDAYS_MONDAY;????? ??? EMDAYS_TUESDAY;????? ??? ……???? ??? };????? ??? ⑦、对struct、union、class变量的命名要求定义的类型用大写。并要加上前缀，其内部变量的命名规则与变量命名规则一致。???? 结构一般用S开头?????? 如：struct???? ScmNPoint???????? {????? ??? int???? nX;//点的X位置?????? int???? nY;???? //点的Y位置??????? };????? ??? 联合体一般用U开头???????? 如:???? union???? UcmLPoint??????? {????? ??? long???? lX;????? ??? long???? lY;???? ??? }????? ??? 类一般用