C语言代码规范
文件结构
每个C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现，称为定义（definition）文件。头文件以“.h”为后缀，定义文件以“.c”为后缀。
版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头（参见版权和版本的声明），主要内容包括：
-
版权信息。（Copyright ©）
-
文件名称，标识符，摘要。（File, Description）
-
当前版本号，作者/修改者，完成日期。 (Version, Author, Date)
-
版本历史信息。 (History)
全部内容尽量使用英文说明
版权和版本的声明
/******************************************************************************
Copyright (C), 2010, Shenzhen G&T Industrial Development Co., Ltd
File: cmd_sock.c
Author: jack
Version: 1.0
Date: 2009.03
Description: network APIs
** History:
** Author (core ID) Date Number Description of Changes
**-----------------------------------------------------------------------------
** bjg019 30-Dec-2009 LIBtt54238 Implement +MIPCLOSE response as unsolicited
** response, after socket was removed from time wait list.
** brz018 08-Dec-2009 LIBtt41180 Report +FTPCLOSE only after receiving CLOSE
** event.
** -----------------------------------------------------------------------------
******************************************************************************/
头文件的结构
头文件由三部分内容组成：
-
头文件开头处的版权和版本的声明。
-
预处理块。
-
函数和数据结构声明等。
规则:
-
为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。
-
用 #include <filename.h>
格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 -
用 #include “filename.h”
格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
C头文件的结构
// 版权和版本声明
#ifndef _COMMAND_SOCKET // 防止被重复引用
#define _COMMAND_SOCKET
#include <math.h> // 引用标准库的头文件
…
#include “myheader.h” // 引用非标准库的头文件
#define SKCMD_CLOSE 0 // 宏定义
#define SKCMD_CONNECT 1
…
void Function1(…); // 全局函数声明
…
#endif
定义文件的结构
定义文件有三部分内容：
-
定义文件开头处的版权和版本的声明。
-
对一些头文件的引用。
-
程序的实现体（包括数据和代码）。
C文件的结构
// 版权和版本声明见示例1-1，此处省略。
#include “graphics.h” // 引用头文件
…
static char myselfIP[32]; // 静态变量
int gReceiveLength; // 全局变量
// 全局函数的实现体
void Function1(…)
{
…
}
规则:
-
用 #include <filename.h>
格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 -
用 #include “filename.h”
格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 -
全局和静态变量的声明统一在文件前部，引用头文件之后，以方便查找。
头文件的作用
-
通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
-
头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。
目录结构
如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”，这些私有的头文件可以和定义文件存放于同一个目录。
程序的版式
版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。（很多编辑软件具有自动排版的功能）
空行
空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。
规则:
-
在每个结构体声明之后、每个函数定义结束之后都要加空行。参见函数之间的空行
-
在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见函数内部的空行
-
文件中不得存在无规则的空行，比如说连续十个空行
函数之间的空行
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
函数内部的空行
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
}
代码行
规则:
-
结构中元素布局合理，一行只定义一个元素
-
一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
-
if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}，且{}单独占用一行。这样可以防止书写失误。
建议:
尽可能在定义变量的同时初始化该变量（就近原则）。如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如
int width = 10; // 定义并初绐化width
int height = 10; // 定义并初绐化height
int depth = 10; // 定义并初绐化depth
风格良好的代码行
int width; // 宽度
int height; // 高度
int depth; // 深度
x = a + b;
y = c + d;<
最低0.47元/天 解锁文章
810
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
