c语言编码规约 1
1 目的 1
2 适用范围 1
3 规定内容 1
1 目的
在软件开发过程中, c语言编程的工作量是相当大的,同一项目参与编程的人可能有各自编程的经验和习惯,不同风格的程序代码使文护工作变得复杂和困难。为了提高c代码的可读性、系统的稳定性及降低文护和升级的成本,特编写本规范以统一各开发人员的c语言的编程工作。
2 适用范围
本规范适用公司所有c语言的编写规范指导。
3 规定内容
1注释本文来自辣.文,论-文·网原文请找腾讯752018766
1-1:一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
1-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Copyright (C), 1988-1999, qubit-star
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表,每条修改记录应包括修改日期、修改2672
[1] [2] [3] [4] [5] [6] [7] 下一页