为了写出好的C语言程序,需要遵守良好的编程规范。清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性。代码规范化的第一个好处就是看着很整齐、很舒服。假如你现在用不规范的方式写了10000行代码,现在能看得懂,但过段时间再回头看时就很吃力了。所以代码要写规范,比如加注释就是代码规范化的一个思想。第二个好处是,把代码写规范后程序不容易出错。如果按照不规范的格式输入代码的话,很容易出错。而代码写规范的话即使出错了查错也会很方便。格式虽然不会影响程序的功能,但会影响可读性。程序的格式追求清晰、美观,是程序风格的重要构成元素。
一、基本要求
(1)程序结构清晰,简单易懂,单个函数的程序行数不得超过100行。
(2)打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
(3)尽量使用标准库函数和公共函数。
(4)不要随意定义全局变量,尽量使用局部变量。
(5)使用括号以避免二义性。
二、可读性要求
(1)可读性第一,效率第二。
(2)保持注释与代码完全一致。
(3)每个源程序文件,都有文件头说明,说明规格见规范。
(4)每个函数,都有函数头说明,说明规格见规范。
(5)主要变量定义或引用时,注释能反映其含义。
(7)常量定义有相应说明。
(8)处理过程的每个阶段都有相关注释说明。
(9)在典型算法前都有注释。
(10)利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为 6个字节。
(11)循环、分支层次不要超过五层。
(12)注释可以与语句在同一行,也可以在上行。
(13)空行和空白字符也是一种特殊注释。
(14)一目了然的语句不加注释。
(15)注释的作用范围可以为:定义、引用、条件分支以及一段代码。
(16)注释行数(不包括程序头和函数头说明部分)应占总行数的 1/5 到 1/3 。