设为首页 加入收藏

TOP

C编程规范阅读笔记
2014-11-24 03:08:15 来源: 作者: 【 】 浏览:2
Tags:编程 规范 阅读 笔记

当这些规范像过马路的时候 那种原则的时,我想我就深刻领悟了程序的魅力。


文件结构


头文件 和 实现或者定义文件 implementation 实现


版本和版本的声明: 位于 头文件和定义文件的开头。


1。版本信息
2。文件名称、标示符、摘要
3。当前版本号、作者、修改者,完成日期
4。版本历史信息


头文件的结构


1。头文件开头处得版权和版权声明
2。预处理模块
3。函数和类结构声明等


规则1。防止重复引用 用ifndef/define/endif结构产生预处理模块。
规则2。用<>引用标准库的头文件,编译器会从标准库目录开始搜索。
规则3。用“”引用非标准库的头文件,编译器从用户的工作目录开始搜索
规则4。头文件只存放声明 而不存放定义


C++语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。



不提倡使用全局变量。尽量不要造文件中出现 extern int value这类声明。



定义文件的结构


1。定义文件开头处得版权和版本声明。
2。对一些头文件的引用。
3。程序的实现体(包括数据和代码)


头文件的作用


1。 通过头文件来调用库功能。
2。 头文件能加强类型的安全检查。


目录结构


文件过多的时候,头文件和实现文件分开保存于不同的目录中。


空行:


规则1. 在每个类声明之后,每个函数结束之后都要加上空行。
规则2.在一个函数体内,逻辑上密切的相关语句之间不加空行,其他地方应加空行分割。


代码行:
规则1.一行代码只做一件事情。
规则2.IF FOR WHILE DO等语句各自占一行,执行语句不得紧随其后 。
规则3.尽可能在定义变量的同时,初始化改变量。


代码行内的空格:


规则1.关键字之后要留空格, 突出关键字
规则2.函数名之后不要留空格。
规则3.二元操作符的前后应当加空格。
规则4.一元操作符的前后不加空格。
规则5.对于表达式较长的FOR语句和IF语句,为紧凑其间,可以适当地去掉一些空格。


对齐:


规则1.程序的分界符{和}应独占一行,并且位于一列。同时与引用他们的语句左对齐。。
规则2.{}之内的代码块在‘{'右边数格处左对齐。



长行拆分:


规则1.代码行最大长度控制在70~80个字符以内。
规则2.长表达式要在低优先级操作符处拆成新行,操作符放在新行之首,拆出的新行要适当的缩进,
使代码整齐,语句可读。



修饰符的位置


规则1.应当讲修饰符'&"和'*"紧靠变量名。


注释:


规则1.注释 是对代码的提示 不是文档
规则2.代码本来就是清楚的,则不必加注释。
规则3.边写代码边注释,修改代码同时修改相应的注释。
规则4.注释应当准确、易懂、防止注释有二义性。
规则5.尽量避免在注释中使用缩写,特别是不常用缩写。
规则6.注释的位置应与被描述的代码相邻。
规则7.当代码比较长,有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。


类的版式:


以数据为中心 PRIVATE放在前面 PUBLIC放在后面。
以行为为中心 PUBLIC放在前面 PRIVATE放在后面。


建议采用 以行为为中心 类应该提供什么样的函数。


】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
分享到: 
上一篇C++ 中_int64的用法 下一篇在Ubuntu下搭建Glut开发环境

评论

帐  号: 密码: (新用户注册)
验 证 码:
表  情:
内  容:

·switch520最新的地址 (2025-12-24 19:19:41)
·微信聊天功能使用了 (2025-12-24 19:19:39)
·websocket和普通的so (2025-12-24 19:19:36)
·Python中文网 - 人生 (2025-12-24 18:49:47)
·【整整648集】这绝对 (2025-12-24 18:49:44)