C语言编程风格规范.doc

Gemway
C语言编程风格与规范
C Coding Style and Standards
1 概述 1
目的与适用范围 1
程序文档(Coding Document) 1
编程风格(Coding Style) 1
2 menting Conventions) 2
注释的原则 2
注释的写法 2
3 命名规则(Naming Conventions) 7
命名的原则 7
函数的命名 8
宏、常量、标识符和标号的命名 8
类型的命名 9
变量的命名 9
4 文件体制(anization) 13
文件命名规则(File Naming Conventions) 13
目录体制(anization) 14
源代码文件(Program Files) 14
文件结构 14
一般规范 15
表达式书写 16
语句格式 17
断言设置 18
变量初值 19
变量置空 19
人为制造错误 19
统一的函数出口 20
错误处理 21
范例 22
头文件(Header File) 25
头文件结构 25
范例 25
工程文件(MAKEFILE) 28
其它文件(Other Files) 31
概述
目的与适用范围
本文件旨在统一本公司的C语言编程风格(C Coding Style),制定一系列编程规范(Coding Standards),使得各项目小组能使用简单、一致、美观的风格进行代码和程序文档的编写,清楚、准确地表达程序员的意图,方便阅读,减少错误,使得程序容易理解、修改、测试和使用。
本文件将达到以下目的:
增强程序易理解性
提高软件可靠性
提高软件可维护性
提高软件开发效率
本文件以MicroSoft Windows Application的程序为范例进行规则描述,其规则适用于其它各种系统下的C语言程序。
本文件的使用对象是有经验的程序员,常识性的概念和术语不另外解释。
程序文档(Coding Document)
程序文档描述程序数据及过程的组成部分、程序做些什么、程序为什么这样做。程序文档被用来了解一个程序内部结构,了解一个软件系统内的程序与程序之间、程序与操作系统之间、程序与其它软件系统之间的相互作用。程序文档对软件的开发和维护是必不可少的,是一个好的编程风格的重要部分。
好的文档应该是简单明了、容易更新、风格一致,同时充分使用编程语言的表达能力,使程序成为自身的文档。
程序就是文档(Program is Document)!
如果一个程序结构良好,注释完善,程序源代码就可以提供全部必要的程序文档。将程序文档建于代码之中,会使程序的复查和修改、程序文档的更新更为容易。
编程风格(Coding Style)
好的编程风格简单、一致、美观,编写的程序结构良好、层次分明、思路清晰,其规则不会复杂得使读者为弄清书写格式而伤脑筋。
程序员在编程过程中必须经常考虑到“怎样更好地测试我的程序?”,使得自己的程序结构清晰整齐,易于测试和排错。
本规范要求采用下述编程风格和编档技术:
程序文档建立在源代码中
有选择性的高级注释
采用意义明确的名字
用缩进格式编写
编程风格前后一致
结构化程序设计
统一函数出口
运用这些技术可以减少对程序注释的需要,并有助于程序自编文档,此外还可以改善程序文档的可维护性。
menting Conventions)
注释的原则
注释的目的是使读者在思想上形成一个概念,从而正确地理解程序。
一般来说,说明程序功能并描述程序各组成部分相互关系的高级注释是最有用的,而逐行解释程序指令如何工作的低级注释则不利于读、写和修改,是不必要的,也是难以维护的。
本规范反对使程序代码由于大量冗长的注释而凌乱不堪,:1时比较合适。
程序员在写注释时,不是逐行地去弄懂某个程序,而是将指令归并,形成更高一级且更易理解的组合:块(Block)(如:用以实现“在报表上画出标题”这段程序)。在源代码中,注释应放在每一块之前,以说明该程序块的作用。程序块的具体操作不用在注释中描述,由程序中有意义的命名来反应,可以通过阅读代码来了解。
指令注释应该尽量少用。不需要对每条程序指令、每一控制过程、每个决策点都作出注释。指令注释只用于特殊情况,如说明某个少见的、复杂的或者经过优