C语言中的代码格式及注意事项(一、基本格式)

参考书目:周兆熊《C程序员从校园到职场》

在实际编写C程序代码过程中,尤其是走向职场或者不断提高自身水平的需要,代码的格式规范可以让我们感受代码韵律之美,也能方便读者去理解代码,只要你不是计算机世界里单打独斗的孤胆勇士,代码更重要的是写给人看的,方便别人也方便自己。

一、头文件(.H)注释

/************************************************************
*版权所有 (C)2015,公司(或个人)名称
*
*文件名称: 
*内容摘要: 
*其他说明: 
*当前版本: 
*作    者:
*完成日期: 
*
*修改记录1:
*    修改日期;
*    版 本 号:
*    修 改 人:
*    修改内容: 
*
*修改记录2:
*    修改日期;
*    版 本 号:
*    修 改 人:
*    修改内容: 
*************************************************************/

#ifndef _XXX_H
#define _XXX_H

/*************************************************************
相关宏定义
*************************************************************/
 /*************************************************************
相关结构体定义
*************************************************************/
/*************************************************************
源程序中的函数声明 
*************************************************************/

#endif 

二、源文件(.C)头部注释

/************************************************************
*版权所有 (C)2015,公司(或个人)名称
*
*文件名称: 
*内容摘要: 
*其他说明: 
*当前版本: 
*作    者:
*完成日期: 
*
*修改记录1:
*    修改日期;
*    版 本 号:
*    修 改 人:
*    修改内容: 
*
*修改记录2:
*    修改日期;
*    版 本 号:
*    修 改 人:
*    修改内容: 
*************************************************************/

/*************************************************************
头文件引用 
*************************************************************/
 /*************************************************************
全局变量定义 
*************************************************************/
/*************************************************************
函数实现 
*************************************************************/

三、函数头部注释

/************************************************************
*功能描述: 
*输入参数: 
*输出参数: 
*返 回 值: 
*其他说明:
*修改日期          版本号         修改人         修改内容 
*—————————————————————————————— 
*YYYYMMDD           XXX            Name            YYY 
*************************************************************/

四、空格和空行

1.空格

在C语言的关键字(例如:if、for、while、switch等)之后要留有空格,以突出关键字,但函数名之后不留空格,与关键字区分开,在函数参数之间要留有空格,如:Function(x, y, z)

二元操作符前后都应留有空格,一元操作符不加空格。

代码结尾不留空格,前面缩进用编译环境自动添加或者空格,尽量不用TAB.

2.空行

函数结束之后要加空行,两个函数之间建议添加两个以上空行。

函数体中不要随便添加空行,只用于分隔关系不大的代码段。

你可能感兴趣的:(C语言中的代码格式及注意事项(一、基本格式))