C语言程序的书写规则
(2017-12-02 21:08:32)| 分类: 教育教学 |
一、
头文件
头文件由三部分内容组成:
2、预处理块。
3、函数和类结构声明等。
【规则】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
【规则】用 #include 格式来引用标准库的头文件(编译器将从标准库目录开始搜索).
【规则】用 #include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)
【建议】头文件中只存放“声明”而不存放“定义”
【建议】不提倡使用全局变量,尽量不要在头文件中出现象extern int value
这类声明。
二、 程序的版式
【规则】在每个类声明之后、每个函数定义结束之后都要加空行。
【规则】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
【规则】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
【规则】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
【建议】尽可能在定义变量的同时初始化该变量(就近原则)
【规则】关键字之后要留空格。象const、virtual、inline、case
等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、
while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。
【规则】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
【规则】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
【规则】‘,’之后要留空格,如Function(x, y,
z)。如果‘;’不是一行的结束符号,其后要留空格。
【规则】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”
“>=”、“<=”、“+”、“*”、“%”、“&&”、
“||”、“<<”,“^”等二元操作符的前后应当加空格。
【规则】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。
【规则】象“[]”、“.”、“->”这类操作符前后不加空格。
【建议】对于表达式比较长的for语句和if语句,为了紧凑可以适当地去掉一些空格,如for (i=0; i<10;
i++)和if ((a<=b) && (c<=d))
【规则】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
【规则】{ }之内的代码块在‘{’右边数格处左对齐。
【规则】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
【规则】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,
使排版整齐,语句可读。
【规则】应当将修饰符 * 和 & 紧靠变量名
注释
注释符为“”。C++语言中,程序块的注释常采用“”,行注释一般采用“//„”。注释通常用于:
重要的代码行或段落提示。
【规则】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
【规则】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如 i++;
// i 加 1,多余的注释
【规则】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
【规则】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
【规则】尽量避免在注释中使用缩写,特别是不常用缩写。
【规则】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
【规则】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。
三、 命名规则
【规则】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。
例如不要把CurrentValue写成NowValue。
【规则】标识符的长度应当符合“min-length &&
max-information”原则。
【规则】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。
的方式,如add_child。别把这两类风格混在一起用。
【规则】程序中不要出现仅靠大小写区分的相似的标识符。
【规则】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。
【规则】变量的名字应当使用“名词”或者“形容词+名词”。
【规则】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就
是对象本身。
【规则】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
【建议】尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑
筋而导致产生无意义的名字(因为用数字编号最省事)。
【规则】类名和函数名用大写字母开头的单词组合而成。
【规则】变量和参数用小写字母开头的单词组合而成。
【规则】常量全用大写的字母,用下划线分割单词。
【规则】静态变量加前缀s_(表示static)。
【规则】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。
【规则】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。
【规则】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形
标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。
【 规则】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优先级。
【规则】不要编写太复杂的复合表达式。
【规则】不要有多用途的复合表达式。
【规则】不要把程序中的复合表达式与“真正的数学表达式”混淆。
布尔变量与零值比较
【规则】不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。
【规则】应当将整型变量用“==”或“!=”直接与0比较。
4.3.3 浮点变量与零值比较
【规则】不可将浮点变量用“==”或“!=”与任何数字比较。
指针变量与零值比较
有时候我们可能会看到 if (NULL == p) 这样古怪的格式。不是程序写错了,是程序员为了防止将 if (p ==
NULL) 误写成 if (p =
NULL),而有意把p和NULL颠倒。编译器认为 if (p = NULL) 是合法的,但是会指出 if (NULL =
p)是错误的,因为NULL不能被赋值。
【建议】在多重循环中,如果有可能,应当将最长的循环放在最内层,最短的循环放在最外层,以减少CPU跨切循环层的次数。
【建议】如果循环体内存在逻辑判断,并且循环次数很大,宜将逻辑判断移到循环体的外面。
【规则】不可在for 循环体内修改循环变量,防止for 循环失去控制。
【建议】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。
四、 函数设计
参数的规则
【规则】参数的书写要完整,不要贪图省事只写参数的类型而省略参数名字。如果函数没有参数,则用void填充。
【规则】参数命名要恰当,顺序要合理。
【规则】如果参数是指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内被意外修改。
【规则】如果输入参数以值传递的方式传递对象,则宜改用“const
&”方式来传递,这样可以省去临时对象的构造和析构过程,从而
提高效率。
【建议】避免函数有太多的参数,参数个数尽量控制在5个以内。如果参数太多,在使用时容易将参数类型或顺序搞错。
【建议】尽量不要使用类型和数目不确定的参数。
【规则】不要省略返回值的类型。
【规则】函数名字与返回值类型在语义上不可冲突。
【规则】不要将正常值和错误标志混在一起返回。正常值用输出参数获得,而错误标志用return语句返回。
【建议】有时候函数原本不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。
【建议】如果函数的返回值是一个对象,有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不
能用“引用传递”,否则会出错。
函数内部实现的规则
【规则】在函数体的“入口处”,对参数的有效性进行检查。
【规则】在函数体的“出口处”,对return语句的正确性和效率进行检查。
【建议】函数的功能要单一,不要设计多用途的函数。
【建议】函数体的规模要小,尽量控制在50行代码之内。
【建议】尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出。建议尽量少用static局部变量,除非必需。
【建议】不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等。
【建议】用于出错处理的返回值一定要清楚,让使用者不容易忽视或误解错误情况。
五、 内存管理
从静态存储区域分配。内存在程序编译的时候就已经分配好,这块内存在程序的整个运行期间都存在。例如全局变量,static变量。
在栈上创建。在执行函数时,函数内局部变量的存储单元都可以在栈上创建,函数执行结束时这些存储单元自动被释放。栈内存
分配运算内置于处理器的指令集中,效率很高,但是分配的内存容量有限。
从堆上分配,亦称动态内存分配。程序在运行的时候用malloc或new申请任意多少的内存,程序员自己负责在何时用free或delete释放内存。动态内存的生存期由我们决定,使用非常灵活,但问题也最多。
内存分配成功并且已经初始化,但操作越过了内存的边界。
忘记了释放内存,造成内存泄露。
释放了内存却继续使用它。
程序中的对象调用关系过于复杂,实在难以搞清楚某个对象究竟是否已经释放了内存,此时应该重新设计数据结构,从根本上解决对
象管理的混乱局面。
函数的return语句写错了,注意不要返回指向“栈内存”的“指针”或者“引用”,因为该内存在函数体结束时被自动销毁。
使用free或delete释放了内存后,没有将指针设置为NULL。导致产生“野指针”。
【规则】用malloc或new申请内存之后,应该立即检查指针值是否为NULL。防止使用指针值为NULL的内存。
【规则】不要忘记为数组和动态内存赋初值。防止将未被初始化的内存作为右值使用。
【规则】避免数组或指针的下标越界,特别要当心发生“多1”或者“少1”操作。
【规则】动态内存的申请与释放必须配对,防止内存泄漏。
【规则】用free或delete释放了内存之后,立即将指针设置为NULL,防止产生“野指针”。
指针操作超越了变量的作用范围。
六、 一些编程经验
越是怕指针,就越要使用指针。不会正确使用指针,肯定算不上是合格的程序员。
程序的时间效率是指运行速度,空间效率是指程序占用内存或者外存的状况。
全局效率是指站在整个系统的角度上考虑的效率,局部效率是指站在模块或函数角度上考虑的效率。
【规则】不要一味地追求程序的效率,应当在满足正确性、可靠性、健壮性、可读性等质量因素的前提下,设法提高程序的效率。
【规则】以提高程序的全局效率为主,提高局部效率为辅。
【规则】在优化程序的效率时,应当先找出限制效率的“瓶颈”,不要在无关紧要之处优化。
【规则】先优化数据结构和算法,再优化执行代码。
【规则】有时候时间效率和空间效率可能对立,此时应当分析那个更重要,作出适当的折衷。例如多花费一些内存来提高性能。
【规则】不要追求紧凑的代码,因为紧凑的代码并不能产生高效的机器码。
【建议】当心那些视觉上不易分辨的操作符发生书写错误。我们经常会把“==”误写成“=”,象“||”、“&&”、“<=”、“>=”这类
符号也很容易发生“丢1”失误。然而编译器却不一定能自动指出这类错误。
【建议】变量(指针、数组)被创建之后应当及时把它们初始化,以防止把未被初始化的变量当成右值使用。
【建议】当心变量的初值、缺省值错误,或者精度不够。
【建议】当心数据类型转换发生错误。尽量使用显式的数据类型转换(让人们知道发生了什么事),避免让编译器轻悄悄地进行隐式
的数据类型转换。
【建议】当心变量发生上溢或下溢,数组的下标越界。
【建议】当心忘记编写错误处理程序,当心错误处理程序本身有误。
【建议】当心文件I/O有错误。
【建议】避免编写技巧性很高代码。
【建议】不要设计面面俱到、非常灵活的数据结构。
【建议】如果原有的代码质量比较好,尽量复用它。但是不要修补很差劲的代码,应当重新编写。
【建议】尽量使用标准库函数,不要“发明”已经存在的库函数。
【建议】尽量不要使用与具体硬件或软件环境关系密切的变量。
【建议】把编译器的选择项设置为最严格状态。
(2)函数名后必须有小括号,函数体放在大括号内。
(3)C程序必须用小写字母书写。
(4)每句的末尾加分号。
(5)可以一行多句。
(6)可以一句多行。
(7)可以在程序的任何位置加注释。
后一篇:算法及其表示方法

加载中…