目的

指导分布式服务器C语言程序开发

针对语言

C语言

制定者

XXX

制定时间

2011年10月8日

项目

规范内容

备注

程序文件头说明

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

* Program Assignment : 程序文件编号

* Author:             作者姓名

* Date:               程序开始编写时间

* Description:         程序文件整体的简短描述

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

在所有源程序文件开头的描述部分。

内容列表

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

* Source code in : 源程序文件路径

* Whole Value List : 全局变量列表

* Function List:

*    functionName1

*    functionName2

*    functionName3

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

提供一个所有内容的列表总结，紧跟着“程序文件头说明”

函数或方法注释头

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

* Function Name: PrintSth

* Purpose: 将输入的字符创打印在屏幕上

* Params :

*    @char *inStr 将要输出打印到屏幕上的字符串。

* Return: 返回一个整型量，0表示打印失败，1表示打印成

* Limitation: 输入的inStr字符串不得为空，长度不得超过1000

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

int PrintSth(char *inStr)

{

…

}

描述程序时如何应用的。提供声明格式，参数类型和参数限制

变量命名规范

l 变量命名不能使用单个字母。

l 使用英文单词，理解上有歧义的单词，需要在变量声明是给出注释说明。

l 多个单词构成的变量名称，除了第一个单词外，其他单词首字母大写，其他字母小写。包括参数变量。

l 全局变量，所有单词首字母大写。其他字母小写。


好的例子：

int strLength;

int indexI;  /*用作 for 循环的下标*/

坏的例子：

   int l, I;


常量命名规范

l 常量命名需要使用英文单词。

l 所有字母大写。

l 单词与单词之间用下划线分割

例如：

   #define MAX_LINE 100


函数命名规范

l 使用英文单词命名。

l 所有单词首字母大写。

l 单词之间没有特殊分隔符。


空白行

l 在写程序时要给出足够多的空行，避免程序看起来过于拥挤。

l 买一个程序部分之间都要用一个空行进行分割。


缩进规范

l 大括号匹配。

l 每增加一层大括号，其间的内容统一增加一个tab的缩进。