程序员编程规范（简约版）

Author: JW. ZHOU

Date: 2014.4.16

基本要求

程序结构要清晰，读起来不费力，单个函数程序行数尽量不要超过100行（不做硬性要求）；程序一定要简洁，避免垃圾程序；尽量使用标准库函数和公共函数；不要随意定义全局变量，尽量使用局部变量。 使用括号以避免二义性。

可读性要求 

可读性第一，效率第二；保持注释与代码完全一致；每个源程序文件，都有文件头说明，说明规格见规范；每个函数，都有函数头说明，说明规格见规范。 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义；常量定义（DEFINE）有相应说明。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释。 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位。循环、分支层次不要超过五层。 注释可以与语句在同一行，也可以在上行。 空行和空白字符也是一种特殊注释。 一目了然的语句不加注释。 注释的作用范围可以为：定义、引用、条件分支以及一段代码。  注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。

命名必须具有一定的实际意义，形式为xAbcFgh，x由变量类型确定，Abc、Fgh表示连续意义字符串，如果连续意义字符串仅两个，可都大写。如OK。

具体例程: 

BOOL类型 bEnable;

ch * char chText 

c * 类对象 cMain（对象实例）

h * Handle（句柄） hWnd 

i * int 

n * 无符号整型 

p * 指针 

sz,str * 字符串 

w WORD 

x,y 坐标 

Char或者TCHAR类型 与Windows API有直接联系的用szAppName[10]形式否则用 

FileName[10]形式,单个字符也可用小写字母表示；

int类型 nCmdShow; 

LONG类型 lParam; 

UINT类型 uNotify; 

DWORD类型 dwStart; 

PSTR类型 pszTip; 

LPSTR类型 lpCmdLine 

LPTSTR类型 lpszClassName; 

LPVOID类型 lpReserved 

WPARAM类型 wParam, 

LPARAM类型 lParam 

HWND类型 hDlg; 

HDC类型 hDC; 

HINSTANCE类型 hInstance 

HANDLE类型 hInstance, 

HICON类型 hIcon; 

int iTmp 

float fTmp 

DWORD dw*

String , AnsiString str * 

m_ 类成员变量 m_nVal, m_bFlag 

g_ 全局变量 g_nMsg, g_bFlag 

局部变量中可采用如下几个通用变量：nTemp，nResult，i，j（一般用于循环变量）。其他资源句柄同上。常量和宏定义必须具有一定的实际意义；常量和宏定义在#include和函数定义之间；常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用；资源名字定义格式: 

菜单:IDM_XX或者CM_XX 

位图:IDB_XX 

对话框:IDD_XX 

字符串:IDS_XX 

DLGINIT:DIALOG_XX 

ICON:IDR_XX 

函数原型说明包括引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名，如是内部函数，只要注释其定义文件名；第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线间隔,示例如下：

void UpdateDB_Tfgd (TRACK_NAME); //Module Name :r01/sdw.c 

void PrintTrackData (TRACK_NAME); //Module Name :r04/tern.c 

void ImportantPoint (void); //Module Name :r01/sdw.c 

void ShowChar (int , int , chtype); //Local Module 

void ScrollUp_V (int , int); //Local Module 

结构体类型命名必须全部用大写字母，原则上前面以下划线开始；结构体变量命名必须用大小写字母组合，第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区，必须注明其所属的进程。全局数据定义只需注意其用途。

示例如下： 

typedef struct 

{ 

char szProductName[20]; 

char szAuthor[20]; 

char szReleaseDate[16]; 

char szVersion[10]; 

unsigned long MaxTables; 

unsigned long UsedTables; 

}DBS_DATABASE; 

 

DBS_DATABASE GdataBase; 

用小写前缀表示类别： 

fm 窗口 

cmd 按钮 

cob combo，下拉式列表框 

txt 文本输入框 

lab labal，标签 

img image，图象 

pic picture 

grd Grid，网格 

scr 滚动条 

lst 列表框 

frm fram 

 

原则上注释要求使用中文；文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等，复杂的算法需要加上流程说明; 函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等，复杂的函数需要加上变量用途说明；程序中注释包括:修改时间和作者、方便理解的注释等；

引用一：文件开头的注释模板 

/****************************************************************** 

** 文件名: 

** Copyright (c) 1998-1999 *********公司技术开发部 

** 创建人: 

** 日 期: 

** 修改人: 

** 日 期: 

** 描 述: 

** 

** 版 本: 

**----------------------------------------------------------------------------- 

******************************************************************/ 

 

引用二: 函数开头的注释模板 

/***************************************************************** 

** 函数名: 

** 输 入: a,b,c 

** a--- 

** b--- 

** c--- 

** 输 出: x--- 

** x 为 1, 表示... 

** x 为 0, 表示... 

** 功能描述: 

** 全局变量: 

** 调用模块: 

** 作 者: 

** 日 期: 

** 修 改: 

** 日 期: 

** 版本 

****************************************************************/ 

 

引用三: 程序中的注释模板 

/*----------------------------------------------------------*/ 

/* 注释内容 */ 

/*----------------------------------------------------------*/ 

 

// 该变量表示….

 

结构化要求 

禁止出现两条等价的支路；禁止GOTO语句；用 IF 语句来强调只执行两组语句中的一组；禁止 ELSE GOTO 和 ELSE RETURN；用 CASE 实现多路分支；避免从循环引出多个出口； 函数只有一个出口；不使用条件赋值语句； 避免不必要的分支；不要轻易用条件分支去替换逻辑表达式。

正确性与容错性要求 

程序首先是正确，其次是优美 ；无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查；改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响；所有变量在调用前必须被初始化；对所有的用户输入，必须进行合法性检查；不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ，不可靠；程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等；单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。

可重用性要求 

重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类；公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性；公共控件或类应建立使用模板。

 

[参考文献或文章来源]

1、http://lwzy-crack.blog.163.com/blog/static/95272042200901424250482/

2、高质量C++/C编程指南, 林锐博士