C语⾔中的代码格式及注意事项(⼀、基本格式)
参考书⽬:周兆熊《C程序员从校园到职场》
在实际编写C程序代码过程中,尤其是⾛向职场或者不断提⾼⾃⾝⽔平的需要,代码的格式规范可以让我们感受代码韵律之美,也能⽅便读者去理解代码,只要你不是计算机世界⾥单打独⽃的孤胆勇⼠,代码更重要的是写给⼈看的,⽅便别⼈也⽅便⾃⼰。
⼀、头⽂件(.H)注释
/************************************************************
*版权所有(C)2015,公司(或个⼈)名称
*
*⽂件名称:
*内容摘要:
*其他说明:
*当前版本:
*作者:
*完成⽇期:
*
*修改记录1:
* 修改⽇期;
* 版本号:
* 修改⼈:
* 修改内容:
*
*修改记录2:
* 修改⽇期;
* 版本号:
* 修改⼈:
* 修改内容:
*************************************************************/
#ifndef _XXX_H
#define _XXX_H
/*************************************************************
相关宏定义
*************************************************************/
/*************************************************************
基础c语言代码
相关结构体定义
*************************************************************/
/*************************************************************
源程序中的函数声明
*************************************************************/
#endif
⼆、源⽂件(.C)头部注释
/************************************************************
*版权所有(C)2015,公司(或个⼈)名称
*
*⽂件名称:
*内容摘要:
*其他说明:
*当前版本:
*作者:
*完成⽇期:
*
*修改记录1:
* 修改⽇期;
* 版本号:
* 修改⼈:
* 修改内容:
*
*修改记录2:
* 修改⽇期;
* 版本号:
* 修改⼈:
* 修改内容:
*************************************************************/
/*************************************************************
头⽂件引⽤
*************************************************************/
/*************************************************************
全局变量定义
*************************************************************/
/*************************************************************
函数实现
*************************************************************/
三、函数头部注释
/************************************************************
*功能描述:
*输⼊参数:
*输出参数:
*返回值:
*其他说明:
*修改⽇期版本号修改⼈修改内容
*——————————————————————————————
*YYYYMMDD XXX Name YYY
*************************************************************/
四、空格和空⾏
1.空格
在C语⾔的关键字(例如:if、for、while、switch等)之后要留有空格,以突出关键字,但函数名之后不留空格,与关键字区分开,在函数参数之间要留有空格,如:Function(x, y, z)
⼆元操作符前后都应留有空格,⼀元操作符不加空格。
代码结尾不留空格,前⾯缩进⽤编译环境⾃动添加或者空格,尽量不⽤TAB.
2.空⾏
函数结束之后要加空⾏,两个函数之间建议添加两个以上空⾏。
函数体中不要随便添加空⾏,只⽤于分隔关系不⼤的代码段。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论