C代码规范及建议
C代码规范及建议
(草稿)
版本：0.9
起草人：
2006.06.30
目录一、文件结构
1．1 版权和版本的声明
1．2 头文件的结构
1．3 定义文件的结构
二、文件的版式
2．1 空行的用法
2．2 代码行
2．3 代码行内的空格
2．4 对齐
2．5 长行拆分
2．6 修饰符的位置
2．7 注释
三、命名规则
3．1 命名基本规则
四、表达式和基本语句
4．1 运算符的优先级
4．2 复合表达式
4．3 if 语句
4．4 循环语句的效率
五、函数设计
5．1 参数的规则
5．2 返回值的规则
5．3 函数内部实现的规则
5．4 其它建议
六、其它经验和建议
6．1 提高程序的效率
一、文件结构
每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。
C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀
1．1 版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头，主要内容有：
（1）版权信息。
（2）文件名称，文件内容摘要。
（3）当前版本号，最后修改日期。
格式如下：
/*--------------------------------------------------------------------------
文件名称
空行
文件摘要
Version版本号
Last Modify: 最后更改日期
Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd.
All rights reserved.
--------------------------------------------------------------------------*/
示例如下：
/*--------------------------------------------------------------------------
Siss8118.h
Header file for Siss5118
Version 1.0
Last Modify: 2005.12.30
Copyright (c) 2006 Shenzhen International Solution Software Co., Ltd.
All rights reserved.
--------------------------------------------------------------------------*/
示例1-1 版权和版本的声明
头文件由三部分内容组成：
（1）头文件开头处的版权和版本声明
（2）预处理块
（3）函数和结构体声明等
假设头文件名称为Syscfg.h，头文件的结构参见示例
1.2.1 为了防止头文件被重复引用，应当用#ifndef/#define/#endif 结构产生预处理块
1.2.2 用#include
1.2.5 结构体定义应使用typedef定义结构体别名，避免直接使用struct直接定义结构体。1.2.6 尽量避免使用全局变量，确实需要使用全局变量供其它模块引用时，必须在头文件中使用类似extern int value声明。
1.2.7 头文件中存放需要引用的特殊宏(使用#define定义的宏替换)
1.2.8 在函数声明前存放函数需要引用的常量宏(使用#define定义的常量)
示例如下：
// 版权和版本声明见示例1-1，此处省略。
#ifndef _SYSCFG_H // 防止syscfg.h 被重复引用
#define _SYSCFG_H
#include
…
#include “main.h” // 头文件中需要引用非标准库的头文件
…
#define MEM_TYPE code // 特殊宏定义
typedef struct //结构体定义
{
…
}tSysCfg;
extern int iSysStatus; //全局变量声明
#define SYS_RUNNING_STATUS 1 // 全局函数引用宏定义
#define SYS_CONFIG_STATUS 2
void Function1(…); // 全局函数声明
…
#endif // _SYSCFG_H
示例1-2 头文件的结构
定义文件有三部分内容：
（1）定义文件开头处的版权和版本声明（参见示例1-1）
（2）对一些头文件的引用
（3）程序的全局变量，模块静态变量定义
（4）程序的模块静态函数声明
（5）程序的实现体（包括数据和代码）
假设定义文件的名称为Syscfg.c，定义文件的结构参见示例1-3。
// 版权和版本声明见示例1-1，此处省略。
#include
…
#include “main.h” // 模块中需要引用非标准库的头文件
…
#include “Syscfg.h” // 引用本模块头文件
#define SYS_STATUS_MAX 1 //模块常量宏定义
#define ZeroMemory(Destination,Length) memset((Destination),0,(Length)) //模块特殊宏定义int iSysStatus; //全局变量定义
static int iSys; //模块静态变量定义
static void ReadCfg(…); // 模块静态函数声明
void Function1(…) // 全局函数实现
{
…
}
static void ReadCfg(…) // 模块静态函数实现
{
…
}
示例1-3 C文件的结构
二、文件的版式
2．1 空行的用法
空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，所以不要舍不得用空行。
2.1.1 在每个类声明之后、每个函数定义结束之后都要加空行。 2.1.2 在一个函数体内，函数变量定义后面应加空行分隔。
2.1.3 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 示例如下：
示例2-1空行的用法
2．2 代码行
2.1.1 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
2.1.2 if 、for 、while 、do 等语句自占一行，执行语句不得紧跟其后。
示例2-2代码行的风格：左边的为良好的风格，右边为不良的风格
// 空行
void Function1(…)
{ int i,j; unsigned char cBuff[10]; // 空行 … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … }
// 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } x = a + b;
y = c + d; z = e + f; if (width < height) { dosomething(); } for (initialization; condition; update) {
dosomething(); }
// 空行 other(); x ＝ a + b; y = c + d; z = e + f; if (width < height) dosomething(); for (initialization; condition; update) dosomething(); other();
2．3 代码行内的空格
2.3.1 函数名之后不要留空格，紧跟左括号‘（’。
2.3.2‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。
2.3.3‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。
2.3.4 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。
2.3.5 一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。
2.3.6 象“［］”、“.”、“->”这类操作符前后不加空格。
2.3.7 对于表达式比较长的for 语句和if 语句，为了紧凑起见可以适当地去掉一些空格，例
2．4 对齐
2.4.1 程序的分界符‘{’和‘}’应独占一行并位于同一列，同时与引用它们的语句左对齐。
2．5 长行拆分
2.5.1 代码行最大长度宜控制在70 至80 个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。
2.5.2 长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。
2．6 修饰符的位置
修饰符* 和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题。若将修饰符* 靠近数据类型，例如：int* x; 从语义上讲此写法比较直观，即x 是int 类型的指针。
上述写法的弊端是容易引起误解，例如：int* x, y; 此处y 容易被误解为指针变量。虽然将x 和y 分行定义可以避免误解，但并不是人人都愿意这样做。
2.6.1 应当将修饰符* 和＆紧靠变量名
例如：
char *name;
int *x, y; // 此处y 不会被误解为指针
2．7 注释
C 语言的注释符为“/*…*/”。C++语言中，程序块的注释常采用“/*…*/”，行注释
一般采用“//…”。注释通常用于：
（1）版本、版权声明；
（2）函数接口说明；
（3）重要的代码行或段落提示。
虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例2-6。
2.7.1 注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
2.7.2 如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。
例如
i++; // i 加1，多余的注释
2.7.3 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
2.7.4 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
2.7.5 尽量避免在注释中使用缩写，特别是不常用缩写。
2.7.6 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
三、命名规则
比较著名的命名规则当推Microsoft 公司的“匈牙利”法，该命名规则的主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”；例如所有的字符变量均以ch为前缀，若是指针变量则追加前缀p。如果一个变量由ppch 开头，则表明它是指向字符指针的指针
“匈牙利”法最大的缺点是烦琐，例如
int i, j, k;
float x, y, z;
倘若采用“匈牙利”命名规则，则应当写成
int iI, iJ, ik; // 前缀i 表示int 类型
float fX, fY, fZ; // 前缀f 表示float 类型
完全采用“匈牙利”命名规则会让程序变得很烦琐，参考其思想制定命名规则如下。3．1 命名基本规则
3.1.1 标识符应当直观且可以拼读，可望文知意，不必进行“解码”。标识符最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。例如不要把CurrentValue 写成NowValue。
3.1.2 标识符的长度应当符合“min-length && max-information”原则。几十年前老ANSI C 规定名字不准超过6 个字符，现今的C++/C 不再有此限制。一般来说，长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好？不见得! 例如变量名maxval 就比maxValueUntilOverflow好用。
单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z 等，它们通常可用作函数内的局部变量。
3.1.3 标识符采用“大小写”混排的方式
3.1.4 程序中不要出现仅靠大小写区分的相似的标识符。
例如：
int x, X; // 变量x 与X 容易混淆
void foo(int x); // 函数foo 与FOO 容易混淆
void FOO(float x);
3.1.5 程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的
作用域不同而不会发生语法错误，但会使人误解。
3.1.6 变量的名字应当使用“名词”或者“形容词＋名词”。
例如：
float value;
float oldValue;
float newValue;
3.1.7 全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。
类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。
例如：
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
例如：
int minValue;
int maxValue;
int SetValue(…);
int GetValue(…);
3.1.8 尽量避免名字中出现数字编号，如Value1,Value2 等，除非逻辑上的确需要编号。
3.1.9 函数名用大写字母开头的单词组合而成。
例如：
void Draw(void); // 函数名
void SetValue(int value); // 函数名
3.1.10 常量全用大写的字母，用下划线分割单词。
例如：
#define MAX_VALUE 100;
#define MAX_LENGTH 100;
3.1.11 静态变量加前缀s_（表示static）。
例如：
static int s_initValue; // 静态变量
3.1.12 如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。例如：
int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量
四、表达式和基本语句
4．1 运算符的优先级
C 语言的运算符有数十个，运算符的优先级与结合律须查询相关编译器手册，注意一元运算符+ - * 的优先级高于对应的二元运算符。
4.1.1 如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。由于将运算符的优先级与结合律熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确定表达式的操作顺序。例如：
word = (high << 8) | low
if ((a | b) && (a & c))
4．2 复合表达式
如a = b = c = 0 这样的表达式称为复合表达式。允许复合表达式存在的理由是：
（1）书写简洁；
（2）可以提高编译效率。但要防止滥用复合表达式。
4.2.1 不要编写太复杂的复合表达式。
例如：
i = a >= b && c < d && c + f <= g + h ; // 复合表达式过于复杂
4.2.2 不要有多用途的复合表达式。
例如：
d = (a = b + c) + r ;
该表达式既求a 值又求d 值。应该拆分为两个独立的语句：
a =
b + c;
d = a + r;
4．3 if 语句
布尔变量与零值比较
4.3.1 不可将布尔变量直接与TRUE、FALSE 或者1、0 进行比较。根据布尔类型的语义，零值为“假”（记为FALSE），任何非零值都是“真”（记为TRUE）。TRUE 的值究竟是什么并没有统一的标准。例如Visual C++ 将TRUE 定义为1，而Visual Basic 则将TRUE 定义为-1。假设布尔变量名字为flag，它与零值比较的标准if 语句如下：
if (flag) // 表示flag 为真
if (!flag) // 表示flag 为假
其它的用法都属于不良风格，例如：
if (flag == TRUE)
if (flag == 1 )
if (flag == FALSE)
if (flag == 0)
整型变量与零值比较
4.3.2 应当将整型变量用“==”或“！=”直接与0 比较。假设整型变量的名字为value，它与零值比较的标准if 语句如下：
if (value == 0)
if (value != 0)
不可模仿布尔变量的风格而写成
if (value) // 会让人误解value 是布尔变量
if (!value)
浮点变量与零值比较
4.3.3 不可将浮点变量用“==”或“！=”与任何数字比较。千万要留意，无论是float 还是double 类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“！=”与数字比
较，应该设法转化成“>=”或“<=”形式。
假设浮点变量的名字为x，应当将
if (x == 0.0) // 隐含错误的比较
转化为
if ((x>=-EPSINON) && (x<=EPSINON))
其中EPSINON 是允许的误差（即精度）。
指针变量与零值比较
4.3.4 应当将指针变量用“==”或“！=”与NULL 比较。指针变量的零值是“空”（记为NULL）。尽管NULL 的值与0 相同，但是两者意义不同。假设指针变量的名字为p，它与零值比较的标准if 语句如下：
if (p == NULL) // p 与NULL 显式比较，强调p 是指针变量
if (p != NULL)
不要写成
if (p == 0) // 容易让人误解p 是整型变量
if (p != 0)
或者
if (p) // 容易让人误解p 是布尔变量
if (!p)
4．4 循环语句的效率
C循环语句中，for 语句使用频率最高，while语句其次，do语句很少用。提高循环体效率的基本办法是降低循环体的复杂性。
4.4.1 在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，
4.4.2 如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。示例4-4(c)的程序比示例4-4(d)多执行了N-1 次逻辑判断。并且由于前者老要进行逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。如果N 非常大，最好采用示例4-4(d)的写法，可以提高效率。如果N
非常小，两者效率差别并不明显，采用
五、函数设计
函数接口的两个要素是参数和返回值。C 语言中，函数的参数和返回值的传递方式有两种：值传递（pass by value）和指针传递（pass by pointer）。
5．1 参数的规则
5.1.1 参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字。如果函数没有参数，则用void 填充。
例如：
void SetValue(int width, int height); // 良好的风格
void SetValue(int, int); // 不良的风格
float GetValue(void); // 良好的风格
float GetValue(); // 不良的风格
5.1.2 参数命名要恰当，顺序要合理。
例如编写字符串拷贝函数StringCopy，它有两个参数。如果把参数名字起为str1 和str2，例如void StringCopy(char *str1, char *str2);
那么我们很难搞清楚究竟是把str1 拷贝到str2 中，还是刚好倒过来。可以把参数名字起得更有意义，如叫strSource 和strDestination。这样从名字上就可以看出应该把strSource 拷贝到strDestination。
还有一个问题，这两个参数那一个该在前那一个该在后？参数的顺序要遵循程序员的习惯。一般地，应将目的参数放在前面，源参数放在后面。如果将函数声明为：
void StringCopy(char *strSource, char *strDestination);
别人在使用时可能会不假思索地写成如下形式：
char str[20];
StringCopy(str, “Hello World”); // 参数顺序颠倒
5.1.3 如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体内被意外修改。例如：
void StringCopy(char *strDestination，const char *strSource);
5.1.4 避免函数有太多的参数，参数个数尽量控制在5 个以内。如果参数太多，在使用时容易将参数类型或顺序搞错。
5．2 返回值的规则
5.2.1 不要省略返回值的类型。
C 语言中，凡不加类型说明的函数，一律自动按整型处理。这样做不会有什么好处，却容易被误解为void 类型。
5.2.2 函数名字与返回值类型在语义上不可冲突。
5.2.3 不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误标志用return 语句返回。
5．3 函数内部实现的规则
不同功能的函数其内部实现各不相同，看起来似乎无法就“内部实现”达成一致的观点。但根据经验，我们可以在函数体的“入口处”和“出口处”从严把关，从而提高函数的质量。5.3.1 在函数体的“入口处”，对参数的进行必要的有效性进行检查。
很多程序错误是由非法参数引起的，我们进行有效性检查来防止此类错误。
(1) 使用参数检查来捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的
(2) 在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用参数检查对假定进行检查
5.3.2 在函数体的“出口处”，对return 语句的正确性和效率进行检查。
（1）return 语句不可返回指向“局部变量”的“指针”，因为该内存在函数体结束时被自动销毁。例如
char * Func(void)
{
char str[] = “hello world”; // str 的内存位于栈上
…
return str; // 将导致错误
}
（2）要搞清楚返回的究竟是“值”还是“指针”
（3）如果函数返回值是一个变量，要考虑return 语句的效率
return int(x + y); // 创建一个临时变量并返回它
这是临时变量的语法，表示“创建一个临时变量并返回它”。不要以为它与“先创建
一个局部变量temp 并返回它的结果”是等价的，如
int temp = x + y;
return temp;
实质不然，上述代码将发生三件事。首先，temp被创建；然后把temp 拷贝到保存返回值的存储单元中；最后，temp在函数结束时被销毁。然而“创建一个临时变量并返回它”的过程是不同的，编译器直接把临时变量创建在存储单元中，省去了拷贝和销毁的化费，提高了效率。5．4 其它建议
5.4.1 函数的功能要单一，不要设计多用途的函数。
5.4.2 函数体的规模要小，尽量控制在50 行代码之内。
5.4.3 尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出。带有“记忆”功能的函数，其行为可能是不可预测的，因为它的行为可能取决于某种“记忆状态”。这样的函数既不易理解又不利于测试和维护。在C语言中，函数的static 局部变量是函数的“记忆”存储器。建议尽量少用static 局部变量，除非必需。
5.4.4不仅要检查输入参数的有效性，还要检查通过其它途径进入函数体内
的变量的有效性，例如全局变量、文件句柄等。
5.4.5 用于出错处理的返回值一定要清楚，让使用者不容易忽视或误解错误情况。
六、其它经验和建议
6．1 提高程序的效率
程序的时间效率是指运行速度，空间效率是指程序占用内存或者外存的状况。全局效率是指站在整个系统的角度上考虑的效率，局部效率是指站在模块或函数角度上考虑的效率。
6.1.1 不要一味地追求程序的效率，应当在满足正确性、可靠性、健壮性、可读性等质量因素的前提下，设法提高程序的效率。
6.1.2 以提高程序的全局效率为主，提高局部效率为辅。
6.1.3 在优化程序的效率时，应当先找出限制效率的“瓶颈”，不要在无关紧要之处优化。
6.1.4 先优化数据结构和算法，再优化执行代码。
6.1.5 有时候时间效率和空间效率可能对立，此时应当分析那个更重要，作出适当的折衷。例如多花费一些内存来提高性能。
6.1.6 不要追求紧凑的代码，因为紧凑的代码并不能产生高效的机器码。
C语言注释规范
C语言注释规范 1.注释原则 同一软件项目开发中，尽量保持代码注释规范和统一。 注释方便了代码的阅读和维护。 边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。 注释要简洁明确，不要出现形容词。 对于写的好的注释，我们将是第一个受益者。 大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返回值，参数的使用。 2.文件头部的注释 示例： / * Program Assignment : 该文件的作用 * Author: 作者 * Date: 2013/8/6 14:34 * Description: 该文件的描述 *****/ /* * Source code in : 源代码的路径 * Function List: * initLinear 初始化线性表 * destoryLinear 释放线性表申请的空间 * isLinearEmpty 判断线性表是否为空 * isLinearFull 判断线性表是否为满 * getLinearElementValue 取得下标为index的元素的值 */ 注意：这个函数列表可以快速查询到我们想要了解的函数。 3.结构体，全局变量等的注释 示例： typedef POLYNOMIAL USER_TYPE; /* 新的数据类型的描述*/ int a; /* 全局变量的作用*/ /* 说明结构体的功能*/ typedef struct LINEAR { USER_TYPE *data; /* 每个成员的意义(作用) */ int maxRoom; /* 每个成员的意义(作用) */
int elementCount; /* 每个成员的意义(作用) */ }LINEAR; 4.函数的注释 在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。 示例： /* * Function Name: getLinearElementIndex * Purpose: 取得元素的index值 * Params : * @LINEAR linear 线性表实例 * @USER_TYPE var 类型为USER_TYPE的实例 * @int (*)() cmp 提供接口，让用户定义具体比较函数 * Return: int 返回元素的index值 * Limitation: 如果返回-1，则代表不存在var的元素 */ int getLinearElementIndex(LINEAR linear, USER_TYPE var, int (*cmp)()) { /* * 如果逻辑太过复杂，这里写明该算法的过程和思路。 */ boolean found = FALSE; int i; for(i = 0; i < && !found; i++) if(cmp[i], var) == 0) found = TRUE; if(i >= i = NOT_FOUND; return i; }
C语言编码规范
C语言编程规范 对于程序员来说，能工作的代码并不等于“好”的代码。“好”代码的指标很多，包括易读、易维护、易移植和可靠等。其中，可靠性对嵌入式系统非常重要，尤其是在那些对安全性要求很高的系统中，如飞行器、汽车和工业控制中。这些系统的特点是：只要工作稍有偏差，就有可能造成重大损失或者人员伤亡。一个不容易出错的系统，除了要有很好的硬件设计(如电磁兼容性)，还要有很健壮或者说“安全”的程序。 然而，很少有程序员知道什么样的程序是安全的程序。很多程序只是表面上可以干活，还存在着大量的隐患。当然，这其中也有C语言自身的原因。因为C语言是一门难以掌握的语言，其灵活的编程方式和语法规则对于一个新手来说很可能会成为机关重重的陷阱。同时，C语言的定义还并不完全，即使是国际通用的C语言标准，也还存在着很多未完全定义的地方。要求所有的嵌入式程序员都成为C语言专家，避开所有可能带来危险的编程方式，是不现实的。最好的方法是有一个针对安全性的C语言编程规范，告诉程序员该如何做。 本规范在制定过程中，主要参考了业界比较推崇的《华为软件编程规范和范例》和《MI SRA 2004规则》，适合C语言初学者使用，目的在于在教学中培养学生良好的编程规范和意识、素质，促进所设计程序安全、健壮、可靠、可读与可维护(程序简单、清晰)。考虑到面向的是初学者，为便于教学和课程考核操作，本规范中的要求比较基本。事实上，很多公司都有自己规定的代码风格，包括命名规则、缩进规则等，学生参加工作后，应再进一步学习和应用公司的规范。 建议学生在学习本规范的同时，花点时间阅读本规范的参考文献原文，特别是熟读本规范的参考文献之一的《“安全第一”的C语言编程规范》，深刻理解编程规范与程序安全、健壮、可靠、可读、可维护间的关系和作用，在学习和工作中养成良好的编程风格。 1 排版 1.1 严格采用阶梯层次组织程序代码 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。 程序块的分界符(如C/C++ 语言的大括号‘{’和‘}’)应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if 、for 、do 、while 、switch 、case 语句中的程序都要采用如上的缩进方式。 各层次缩进的风格采用TAB缩进(TAB宽度原则上使用系统默认值，TC使用8空格宽度，VC使用4空格宽度)。示例：
C 代码规范
C#代码规范 1、前言 本文档定义了一些通用的代码规范和准则，一般情况下本文档适用于项目组所有项目，特殊情况下，如果客户有自己的代码规范，以客户的代码优先。 2、大小写约定 2.1、大小写样式，本文中将出现两种大小写样式，这里先分别定义： Pascal大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColor Camel大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 匈牙利命名法 基本原则是：变量名=属性+类型+对象描述。例如：lblName 2.2、标识符大小写规则 2.2.1、下表中列出常见的代码元素的样式规范和示例
2.2.2、除了遵循以上大小写约定外还需注意以下约定（除常量为特例）： ?如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。 ?所有公共的成员如：方法、属性，都应使用Pascal大小写样式 2.3、首缩写词的大小写规则 2.3.1、首字母缩写词 首字母缩写词是由术语或短语中各单词的首字母构成的单词。 例如，HTML是HypertextMarkupLanguage的首字母缩写。为了方便编码规范的实施，本文规定受字母缩写词必须至少为两个单词，正好为两个单词的首字母缩写词称其为“短型首字母缩写词”，两个单词以上的称其为“长型首字母缩写词”
2.3.2、单缩写词 单缩写词是一个单词的缩写。例如，ID是identifier的缩写。 注意：可在标识符中使用的两个缩写词是ID和OK。在采用Pascal大小写格式的标识符中，这两个缩写词的大小写形式应分别为Id和Ok。如果在采用大小写混合格式的标识符中将这两个缩写词用作首个单词，则它们的大小写形式应分别为id和ok。 2.3.3、首字母缩写词有以下大小写规则： 短型首字母缩写词在Pascal大小写样式中，两个字母都应大写。在Camel 大小写样式中，如果是首个单词，两个字母都应小写。例如： ?名为DBRate的属性是一个采用Pascal大小写格式的标识符，它使用短型首字母缩写词(DB)作为首个单词。 ?名为ioChannel的参数是一个采用大小写混合格式的标识符，它使用短型首字母缩写词(IO)作为首个单词。 长型首字母缩写词，在任何大小写样式中都视为一个单词。例如： ?名为XmlWriter的类是一个采用Pascal大小写格式的标识符，它使用长型首字母缩写词作为首个单词。 ?名为htmlReader的参数是一个采用大小写混合格式的标识符，它使用长型首字母缩写词作为首个单词。 2.3.4、复合词的大小写规则： 所有复合词在任何大小写样式中都视为一个完整单词。 例如，hashtable是一个紧凑格式的复合词，应将其视为一个单词并相应地确定大小写。如果采用Pascal大小写格式，则该复合词为Hashtable;如果采用大小写混合格式，则该复合词为hashtable。若要确定某个单词是否是紧凑格式的复合词，请查阅最新的词典。 2.3.5、区分大小写 大小写准则只是为了使标识符更易于阅读和辨认。不能将大小写规则用作避免库元素之间的命名冲突的手段。 3、通用命名约定
C语言编程规范
编码规范 1. 头文件编码规范 (2) 2. 函数编写规范 (2) 3. 标识符命名与定义 (2) 3.1通用命名规则 (2) 3.2 变量命名规则 (3) 3.3函数命名规则 (3) 3.4 宏的命名规则 (3) 4. 变量 (3) 5. 宏、常量 (4) 6. 质量保证 (4) 7. 程序效率 (5) 8. 注释 (5) 9. 排版与格式 (6) 10. 表达式 (7) 11. 代码编辑、编译 (7) 12. 安全性 (7) 13. 可读性 (7) 14. 可测性 (7) 15. 单元测试 (8) 16. 可移植性 (8)
1. 头文件编码规范 1. 禁止头文件循环依赖。 2. .c/.h文件不要包含用不到的头文件。 3. 禁止在头文件中定义变量。 4. 同一产品统一包含头文件排列方式。（如功能块排序、文件名升序、稳定度排序。） 5. 只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量。 2. 函数编写规范 1. 一个函数仅完成一件功能。 2. 重复代码应该尽可能提炼成函数。 3.为简单功能编写函数 4.函数的返回值要清楚、明了，让使用者不容易忽视错误情况。 5. 避免函数过长，新增函数不超过100行（非空非注释行）。 6. 避免函数的代码块嵌套过深，新增函数的代码块嵌套不超过4层。 7. 可重入函数应避免使用全局变量和禁止使用static变量。 8. 设计高扇入，合理扇出（小于7）的函数。 9. 废弃代码（没有被调用的函数和变量)要及时注释（有助于更好理解程序）。 10. 对所调用函数的错误返回码要仔细、全面地处理。 11. 函数不变参数使用const。 12. 函数应避免使用全局变量、静态局部变量和I/O操作，不可避免的地方应集中使用。 13. 函数的参数个数不超过5个。 14. 减少或禁止函数本身或函数间的递归调用 3. 标识符命名与定义 3.1通用命名规则 1. 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。 2. 除了常见的通用缩写以外，不使用单词缩写，不得使用汉语拼音。 示例： argument 可缩写为arg buffer 可缩写为buff clock 可缩写为clk command 可缩写为cmd compare 可缩写为cmp configuration 可缩写为cfg device 可缩写为dev error 可缩写为err hexadecimal 可缩写为hex increment 可缩写为inc initialize 可缩写为init maximum 可缩写为max message 可缩写为msg minimum 可缩写为min parameter 可缩写为para
C语言编写规范之注释
1、头文件包含Includes 2、私有类型定义 Private typedef 3、私有定义Private define 4、私有宏定义 Private macro 5、私有变量 Private variables 6、私有函数原型Private function prototypes 7、私有函数Private functions 8、私有函数前注释 /****************************************************************************** * * Function Name : FSMC_NOR_Init * Description : Configures the FSMC and GPIOs to interface with the NOR memory. * This function must be called before any write/read operation * on the NOR. * Input : None * Output : None * Return : None ******************************************************************************* / 9、程序块采用缩进风格编写，缩进空格为4。 10、相对独立的程序块之间、变量说明之后必须加空行； 11、较长的字符（>80字符）要分成多行书写，长表达式要在低优先级操作符划分新行，操作符放在新行之首，新行要恰当缩进，保持排版整齐； 12、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首; 13、若函数或过程中的参数较长，则要进行适当的划分。 14、不允许把多个短语句写在一行中，即一行只写一条语句。 15、if、for、do、while、case、switch、default等语句自占一行，且if、for、 do、while等语句的执行语句部分无论多少都要加括号{}。 16、对齐只使用空格键，不使用TAB键； 17、 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求 18、 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一 列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 19、 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或
标准C语言规范
C语言编码规范 1．文件、函数规范 根据功能划分文件。文件名与主控函数名相同；主控函数必须放在最前面；函数的长度一般不宜超过150行；文件长度不宜超过500行。标准的文件头格式如下： 函数名： 功能： 调用函数：所涉及的主要功能函数 调用参数：必须详细说明 返回值： 编写时间： 修改时间：修改时包含此项 2．命名规范 ①函数命名规范 以便于理解为原则，由一个或多个单词或单词缩写组合而成，单词首字母大写。 如AddItem()，GetInt()，FxaUp() ②变量命名规范 由变量类型为前缀，加上函数命名规范组合而成。具体前缀命名方法如下：sh------short, i------int, l------long, c------char, f------float, d------double, p------pointer 字符串数组也使用p标志 静态变量名前用s标志 数组变量名前用stru标志 全局变量使用前缀g_标志 如：dBalance，fInterest，pName, sCustomer，struPersonWang, g_iOperNo 3．书写规范 ⑴对齐原则 同一层次的语句必须左对齐。“{”和“}”必须独占一行。 ⑵缩进原则 不同层次的语句必须遵从缩进原则，一般缩进四个字符为宜,TAB值设为4。 Case后的语句（简短注释语句除外）应另起一行，且须与“：”相接。 ⑶分行书写原则 当行超过屏幕上的行时，应分行书写。 ⑷注释符要求 单行注释符使用“//”，多行注释符使用“/*……*/”，注释符必须遵从前面3条原则，“/*”应与“*/”对齐。 4．语法规范
C语言开发规范
软件开发规范 在研究项目团队协作开发的情况下（这里的团队协作也适合于应用项目的开发），编程时应该强调的一个重要方面是程序的易读性，在保证软件速度等性能指标能满足用户需求的情况下，能让其他程序员容易读懂你所编写的程序。若研究项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格，可以让协作者、后继者和自己一目了然，在很短的时间内看清楚程序结构，理解设计的思路，大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性。 制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。 本软件开发规范适合讨论C/C++程序设计。 1 文件结构 每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。 文件信息声明 文件信息声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息； （2）文件名称，项目代码，摘要，参考文献； ？ （3）当前版本号，作者/修改者，完成日期； （4）版本历史信息； （5）主要函数描述。
.... 例如一个short*型的变量应该表示为pnStart； ☆【规则】全局变量用g_开头；例如一个全局的长型变量定义为g_lFileNum， 即：变量名＝g_＋变量类型＋变量的英文意思(或缩写)； ☆【规则】静态变量采用s_开头；例如一个静态的指针变量定义为s_plPrevInst， 即：变量名＝s_＋变量类型＋变量的英文意思(或缩写)；
c代码规范
c代码规范(总7页) -CAL-FENGHAI.-(YICAI)-Company One1 -CAL-本页仅作为文档封面，使用请直接删除
C# 代码规范 1、前言 本文档定义了一些通用的代码规范和准则，一般情况下本文档适用于项目组所有项目，特殊情况下，如果客户有自己的代码规范，以客户的代码优先。 2、大小写约定 2.1、大小写样式，本文中将出现两种大小写样式，这里先分别定义： Pascal大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：BackColor Camel大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 匈牙利命名法 基本原则是：变量名=属性+类型+对象描述。例如：lblName 2.2、标识符大小写规则 2.2.1、下表中列出常见的代码元素的样式规范和示例 标识符规则示例 类Pascal AppDomain 枚举类型Pascal ErrorLevel 枚举值Pascal Warning 事件Pascal ValueChanging, ValueChanged 异常类Pascal WebException 只读的静态字段Pascal CurrentUser 接口Pascal IDisposable 方法Pascal ToString 命名空间Pascal 参数Camel typeName 属性Pascal Name 常量全大写MAXLENGTH, LENGTH_MAX Web或Win控件匈牙利txtName 2.2.2、除了遵循以上大小写约定外还需注意以下约定（除常量为特例）： 如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。 所有公共的成员如：方法、属性，都应使用Pascal大小写样式 2.3、首缩写词的大小写规则 2.3.1、首字母缩写词 首字母缩写词是由术语或短语中各单词的首字母构成的单词。 例如，HTML 是 Hypertext Markup Language 的首字母缩写。为了方便编码规范的实施，本文规定受字母缩写词必须至少为两个单词，正好为两个单词的首字母缩写词称其为“短型首字母缩写词”，两个单词以上的称其为“长型首字母缩写词” 2.3.2、单缩写词
c语言格式书写规范
如对您有帮助，请购买打赏，谢谢您！ C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 1.1版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）版权信息。 （2）文件名称，标识符，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allrightsreserved. * *文件名称：filename.h *文件标识： *摘要：简要描述本文件的内容 * *当前版本：1.1 *作者：输入作者（或修改者）名字 *完成日期：2007年7月20日 * *取代版本：1.0 *原作者：输入原作者（或修改者）名字 *完成日期：2007年5月10日 */ 示例1-1版权和版本的声明 1.2头文件的结构 头文件由三部分内容组成： （1）头文件开头处的版权和版本声明（参见示例1-1）。 （2）预处理块。 （3）函数和类结构声明等。 假设头文件名称为SCL_SPI.h，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。 【规则1-2-2】用#include
C_C++代码规范
int fun (int x , int y , int z ){ …… return 0; }if (a >= b && b >= c && c >= d && ...... ) if (p !- NULL ) delete p ;x += y ; val = (mark << 3); void fun (int x , int y , int z ) for (i = 0; i < 10; ++i ) ps :void fun (int x , int y )if (x == y ) i ++; char *p = &temp ; tmp = p ->size ; tmp = q .val ; a = (p +q ) * (m -n ) / (i +j ); 代码规范 １、布局和风格 １、总体布局 ２、空格 总体目标：准确表现代码的逻辑结构；改善可读性；经得起修改。 采用纯块布局，即 “｛” “｝” 垂直对齐； 缩进为４字节，巧用Ｔａｂ键。 对于复杂的表达式，将条件分格在几行； 一行代码宽度应不超过８０个字符，对于较长的语句，应该分行书写，增加代码的可读性。每行仅写一条语句 有需要空格的地方： 双目运算符两侧，需要留有空格。如“＝”， “＋＝”， “＞＝“， ”＋“， ”＆＆“等函数参数之间逗号后； ｆｏｒ语句的分号后面要留有空格 不留空格的地方： 函数名紧跟左括号； 左空号右边和右括号左边不用空格 定义变量后最好加上空行；函数与函数之间最好加上空行； 对于表达式较长的语句，适当去掉空格 ［］，－＞， ．，等操作符前后不加空格 单目运算符前后不加空格，如”！“， ”＆”，“＋＋”等
c语言程序代码编写规范
C语言程序代码编写规范 （初级程序员讨论版） 前言 一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅读，更重要的是能够便于检查错误，提高调试效率，从而最终保证软件的质量和可维护性。 说明 此文挡还在完善改进中，如有不足，欢迎指正。 本文档主要适用于刚刚开始接触编程的初学者。 对于具有一定工程项目开发经验的程序员，建议学习C语言程序代码编写规范 —高级版。 目录 1代码书写规范 2注释书写规范 3命名规范
内容 1 代码书写规范 函数定义 每个函数的定义和说明应该从第1列开始书写。函数名（包括参数表）和函数体的花括号（“{”和“}”）应该各占一行。在函数体结尾的括号（“}”）后面应该加上注释，注释中应该包括函数名，这样比较方便进行括号配对检查，也可以清晰地看出来函数是否结束。 范例1：函数的声明 void matMyFunction(int n) { …… } /* matMyFunction*/ 空格的使用 使用空格分割所有演算符号和操作数。 这条规则的例外是“->”,““.”, “()”和“[]”，这些操作符和操作数之间不空格。 当需要把一个程序行的内容分成几行写时，操作符号应该放在行末，而不是下一行的开头。 缩进的设置 代码书写应该遵从结构化的要求，采用缩进的格式。最小缩进量为4个空格，整个文件内部应该统一，不要混用Tab键和4个空格这两种情况，因为不同的编辑器对Tab键的处理方法不同。 折行的使用 每行的长度不要超过80个字符，当程序行太长时，应该分行书写。 分行时应该按照自然的逻辑关系进行，例如：不要把一个简单的逻辑判断写在 两行上。 分行后的缩进应该按照程序的逻辑关系进行对齐。例如：参数表折行后，下面 的行应该在参数表左括号的下方。 范例2：折行的格式
C语言编程规范标准
编码规 1. 头文件编码规 (2) 2. 函数编写规 (2) 3. 标识符命名与定义 (2) 3.1通用命名规则 (2) 3.2 变量命名规则 (3) 3.3函数命名规则 (3) 3.4 宏的命名规则 (3) 4. 变量 (3) 5. 宏、常量 (4) 6. 质量保证 (4) 7. 程序效率 (5) 8. 注释 (5) 9. 排版与格式 (6) 10. 表达式 (7) 11. 代码编辑、编译 (7) 12. 安全性 (7) 13. 可读性 (7) 14. 可测性 (7) 15. 单元测试 (8) 16. 可移植性 (8)
1. 头文件编码规 1. 禁止头文件循环依赖。 2. .c/.h文件不要包含用不到的头文件。 3. 禁止在头文件中定义变量。 4. 同一产品统一包含头文件排列方式。（如功能块排序、文件名升序、稳定度排序。） 5. 只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c过extern的方式使用外部函数接口、变量。 2. 函数编写规 1. 一个函数仅完成一件功能。 2. 重复代码应该尽可能提炼成函数。 3.为简单功能编写函数 4.函数的返回值要清楚、明了，让使用者不容易忽视错误情况。 5. 避免函数过长，新增函数不超过100行（非空非注释行）。 6. 避免函数的代码块嵌套过深，新增函数的代码块嵌套不超过4层。 7. 可重入函数应避免使用全局变量和禁止使用static变量。 8. 设计高扇入，合理扇出（小于7）的函数。 9. 废弃代码（没有被调用的函数和变量)要及时注释（有助于更好理解程序）。 10. 对所调用函数的错误返回码要仔细、全面地处理。 11. 函数不变参数使用const。 12. 函数应避免使用全局变量、静态局部变量和I/O操作，不可避免的地方应集中使用。 13. 函数的参数个数不超过5个。 14. 减少或禁止函数本身或函数间的递归调用 3. 标识符命名与定义 3.1通用命名规则 1. 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。 2. 除了常见的通用缩写以外，不使用单词缩写，不得使用汉语拼音。 示例： argument 可缩写为arg buffer 可缩写为buff clock 可缩写为clk command 可缩写为cmd compare 可缩写为cmp configuration 可缩写为cfg device 可缩写为dev error 可缩写为err hexadecimal 可缩写为hex increment 可缩写为inc initialize 可缩写为init maximum 可缩写为max message 可缩写为msg minimum 可缩写为min parameter 可缩写为para
C语言格式书写规范
C语言格式书写规范 Document number：NOCG-YUNOO-BUYTT-UU986-1986UT
C语言书写规范指南 第1章文件结构 每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀。 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有： （1）版权信息。 （2）文件名称，标识符，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。 /* *Copyright(c)2001,吉林大学物理学院无线电 *Allrightsreserved. * *文件名称： *文件标识： *摘要：简要描述本文件的内容 * *当前版本： *作者：输入作者（或修改者）名字 *完成日期：2007年7月20日 * *取代版本： *原作者：输入原作者（或修改者）名字 *完成日期：2007年5月10日 */ 示例1-1版权和版本的声明 头文件的结构 头文件由三部分内容组成： （1）头文件开头处的版权和版本声明（参见示例1-1）。 （2）预处理块。 （3）函数和类结构声明等。
假设头文件名称为，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。 【规则1-2-2】用#include <>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-2-3】用#include “”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【规则1-2-4】#include后面使用TAB键控制排版。 【规则1-2-5】头文件中只存放“声明”而不存放“定义” 【规则1-2-6】全局变量在头文件中声明,在.c文件中定义 .hexternintvalue;声明。 .cintvalue=0x10;定义。 【规则1-2-7】局部变量在.c中定义(static)unsignedintvalue;定义。 、“->”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当
华为技术有限公司c语言编程规范
DKBA 华为技术有限公司内部技术规范 DKBA 2826-2011.5 C语言编程规范 2011年5月9日发布 2011年5月9日实施 华为技术有限公司 Huawei Technologies Co., Ltd. 版权所有侵权必究 All rights reserved
修订声明Revision declaration 本规范拟制与解释部门： 本规范的相关系列规范或文件： 相关国际规范或文件一致性： 替代或作废的其它规范或文件： 相关规范或文件的相互关系：
目录Table of Contents 0规范制订说明 (5) 0.1前言 (5) 0.2代码总体原则 (5) 0.3规范实施、解释 (6) 0.4术语定义 (6) 1头文件 (6) 2函数 (12) 3标识符命名与定义 (21) 3.1通用命名规则 (21) 3.2文件命名规则 (23) 3.3变量命名规则 (23) 3.4函数命名规则 (24) 3.5宏的命名规则 (24) 4变量 (25) 5宏、常量 (28) 6质量保证 (32) 7程序效率 (36) 8注释 (39) 9排版与格式 (44) 10表达式 (46) 11代码编辑、编译 (49) 12可测性 (50) 13安全性 (51) 13.1字符串操作安全 (51) 13.2整数安全 (52) 13.3格式化输出安全 (56) 13.4文件I/O安全 (57) 13.5其它 (59) 14单元测试 (59) 15可移植性 (60) 16业界编程规范 (60)
C语言编程规范 范围: 本规范适用于公司内使用C语言编码的所有软件。本规范自发布之日起生效，以后新编写的和修改的代码应遵守本规范。 简介： 本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。
C语言编程规范
第一章 C语言编程规范 C语言编程规范使用于所有的平台程序和应用程序开发。 C语言编程规范分为编程环境，命名规范，内容排列，书写格式，注释规范和程序修改等六部分内容。 具体格式参见《C头文件样本》和《C源程序样本》。 1.1编程环境。 包括目录及其权限设置，makefile使用两部分内容。 1.1.1目录设置。 进行C语言程序开发，一般设置如下六个目录。 各目录及其文件的权限一般使用系统确省，也可根据具体需要进行设置。 ●SRC：存放C源程序文件（*.c），数据库语言程序文件（如*.ec）。 ●INCL：存放C头文件（*.h）。 ●OBJ：存放目标文件（*.o）。 ●LIB：存放一般库文件（*.a），动态链接库文件（如*.so）。 ●BIN：存放可执行文件，SHELL文件。 ●BAK：源程序和头文件备份目录（以日期做文件后缀，如*.990806）。 1.1.2Makefile使用。 Makefile存放在SRC目录下，控制程序的编译与连接，库的生成与更新。 Makefile的定义内容和排列顺序为： ●编程环境目录宏定义。 ●C头文件搜索目录宏定义。 ●库文件搜索目录宏定义。 ●编译控制参数宏定义。 ●一般程序编译与连接方法。
●全部程序编译与连接列表。 ●复杂程序（多个.o）连接方法。 1.2命名规范。 包括源程序文件，头文件，目标文件，库文件，执行文件，宏定义，变量，结构，结构元素，函数等十类命名规范。 各类命名规范均基于《系统基本数据名称集》。 1.2.1源程序文件。 ●一般形式：AAABCCCC。不得超过8个字符。 ●AAA（2或3个字符）：表示该源程序所属的系统（如btp，feb等）。 ●B：一般情况可省略。当多个源程序文件属于同一功能的分支程序，用来 表示源程序文件的功能类型（如m表示主程序，i表示输入，o表示输出等）。 ●CCCC：表示源程序的功能。 1.2.2头文件。 ●一般形式：AAACCCCC。不得超过8个字符。 ●AAA（2或3个字符）：表示该头文件所属的系统（如btp，feb等）。 ●CCCCC：表示头文件的功能。 ●如头文件只被某一个源程序文件使用，名称应和源程序文件名称相同。 1.2.3目标文件。 ●一般的，应和源程序文件名称相同。 ●如和源程序文件名称不同，须得到主设计人员和部门主管同意。 1.2.4库文件。 ●库文件的名称一般在系统总体设计时即确定。 ●一般形式：libAAACCCC。 ●前三个字符一般固定为lib。 ●AAA（2或3个字符）：表示该库文件所属的系统（如btp，feb等）。
C语言编码规范
C语言编码规范
文档修改记录 版本版本日期说明编写者审核者V0.1吕晓敏
1排版规则 1)程序应采用缩进风格编写，每层缩进使用一个制表位（TAB），类定义、方法都应顶 格书写； 2)源程序建议使用英文书写，尽量不含有中文。每行不超过80字符。对于较长的语 句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读；循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分； 3)左花括号要另起一行，不能跟在上一行的行末； 4)一个变量定义占一行，一个语句占一行； 5)对独立的程序块之间、变量说明之后必须加空行； 6)在结构成员赋值等情况，等号对齐，最少留一个空格； 7)若函数或过程中的参数较长，则要进行适当的划分。 8)形参的排序风格： 最常使用的参数放在第一位； 输入参数列表应放在输出参数列表的左边； 将通用的参数放在特殊的参数的左边。 2命名规范 2.1应用程序的命名 “系统简称”+模块名称 2.2子模块的命名 每个子模块的名字应该由描述模块功能的1-3以单词组成。每个单词的首字母应大写。在这些单词中可以使用一些较通用的缩写。 2.3变量的命名 变量的命名的基本原则是使得变量的含义能够从名字中直接理解。可以用多个英文单词拼写而成，每个英文单词的首字母要大写，其中英文单词有缩写的可用缩写；变量的前缀表示该变量的类型；对于作用域跨越10行以上的变量名称不能少于4个字符，除循环变量，累加变量外不得使用I、j、k等名称的变量。变量分为取全局变量和局部变量，对于全局变量以加前缀“g_”来区分。 使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写标识符种类书写规范示例 函数/过程名/变量一般标识符CheckButtonStates 宏标识符大写标识符SALES_TAX 类型定义‘T’+一般标识符TMyType 类标识符‘C’+一般标识符CEditBox 结构标识符‘S’+一般标识符SMyStructure 联合标识符‘U’+一般标识符UMyUnion
c代码规范
C# 代码规范 1、前言 本文档定义了一些通用的代码规范和准则，一般情况下本文档适用于项目组所有项目，特殊情况下，如果客户有自己的代码规范，以客户的代码优先。 2、大小写约定 2.1、大小写样式，本文中将出现两种大小写样式，这里先分别定义： Pascal大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：BackColor Camel大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 匈牙利命名法 基本原则是：变量名=属性+类型+对象描述。例如：lblName 2.2、标识符大小写规则 2.2.1、下表中列出常见的代码元素的样式规范和示例
枚举类型Pascal ErrorLevel 枚举值Pascal Warning 事件Pascal ValueChanging, ValueChanged 异常类Pascal WebException 只读的静态字段Pascal CurrentUser 接口Pascal IDisposable 方法Pascal ToString 命名空间Pascal System.Data 参数Camel typeName 属性Pascal Name 常量全大写MAXLENGTH, LENGTH_MAX Web或Win控件匈牙利txtName 2.2.2、除了遵循以上大小写约定外还需注意以下约定（除常量为特例）： 如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。 所有公共的成员如：方法、属性，都应使用Pascal大小写样式 2.3、首缩写词的大小写规则
C语言代码风格规范
0. 说明 本规范尚在完善中，随时更新。 代码风格以增强程序可读性和可维护性为目标，并非金科玉律。在满足可读性和可维护性的前提下，可以适当灵活。参考：高质量C++/C 编程指南 1. 注释 1.程序中必须有清晰的注释； 2.程序头部要有程序整体说明信息； 3.每个函数（main除外）都要有注释说明该函数的功能，及其参数和返回值的意义； 4.每个变量都要有注释说明其用途(for 循环中的下标除外)； 5.代码中要有适当的注释说明代码段的功能。 2. 缩进 1.缩进的宽度为4个字符，鼓励用空格缩进, tab亦可(但尽量避免两者混用)； 2.凡函数、if、while、for、do-while、switch等都要使用缩进。 3. 标识符命名 1.凡标识符的命名要尽量能直观反映该标识符的功能（如做到这一点，可免去注释说明）； 2.标识符用英文命名，不可用汉语拼音； 3.变量命名采用“variable_name”的形式； 4.函数命名采用“FunctionName”的形式； 5.宏、常量、枚举的命名采用“MACRO_NAME”的形式。 4. 空行及空格 1.以增强可读性为目标，适当使用空行和空格； 2.不可出现连续的两个及两个以上的空行； 3.代码功能段之间用空行分隔； 4.不在行尾的每个逗号和分号后要有一个空格； 5.一般每个运算符前后都要有一个空格； 6.if, while, for, do, switch 和判断条件之间要有一个空格。 5. 其它 1.左大括号“{”后不可出现代码； 2.右大括号“}”前不可出现代码； 3.每行只能写一条代码，且该行代码总长不可超过80个字符； 4.常数应定义为宏、枚举或常量； 5.……