《C++编程规范——101条规则、准则与最佳实践》笔记000

原创 2016年08月29日 22:27:11

C++编程规范

C++ coding standards

Author
Herb Sutter 《Exceptional C++ Style》 《Exceptional C++》 《More Exceptional C++》
Andrei Alexandrescu 《Modern C++ Design》 Loki

组织和策略问题

如果人们按照程序员编程的方式修建房屋,那么一只啄木鸟就能毁灭整个文明。 ——Gerald Weinberg

第0条 不要拘泥于小节(了解哪些东西不应该标准化)

摘要

只规定需要规定的事情:不要强制施加个人喜好或者过时的做法。

讨论

应该在每个源文件乃至每个项目中都使用一致的格式,因为同一段代码中要在几种编程风格之间换来换去是很不舒服的。
但是无需在多个项目或者整个公司范围内强制实施一致的格式。
不要尝试强制实施过时的规则。
  • 不要规定缩进多少,应该规定要用缩进来体现代码的结构。缩进空格的数量可以遵照个人习惯,但是至少在每个文件中应该保持一致。
  • 不要强制行的具体长度,应该保证代码行的长度有利于阅读。可以遵照个人习惯来决定行长,但是不要过长。研究表明,文字长度不超过10个单词最利于阅读。
  • 不要在命名方面规定过多,应该规定的是使用一致的命名规范。只有两点是必需的:(1)永远不要使用“晦涩的名称”,即以下划线开始或者包含双下划线的名称;(2)总是使用形如——ONLY_UPPERCASE_NAMES的全大写字母表示宏,不要考虑使用常见的词或者缩略词作为宏的名称(包括常见的模板参数,比如T和U;像#define T anything这样的代码是极容易混淆的)。此外,应该使用一致的、有意义的名称,遵循文件的或者模块的规范。(如果无法决定自己的命名规范,可以尝试如下命名规则:类、函数和枚举的名称形如LikeThis,即单词首字母大写;变量名形如likeThis,即第一个单词首字母小写,第二个单词首字母大写;私有成员变量名形如likeThis_;宏名称形如LIKE_THIS。)
  • 不要规定注释风格(除非需要使用工具从特定的体例中提取出文档),应该编写有用的注释。尽可能编写代码而不是写注释。不要在注释中重复写代码语义,这样很容易产生不一致。应该编写的是解释方法和原理的说明性注释。

示例

例1 大括号的位置

//以下代码在可读性方面不存在差别
void using_k_and_r_style() {
    //
}
void putting_each_brace_on_its_own_line()
{
    //
}
void or_putting_each_brace_on_its_own_line_intented()
    {
    //
    }
//不要随意地或者以容易混淆作用域嵌套关系的方式放置大括号,要尽量遵循每个文件中已经使用的体例。
例2 空格与制表符

  • 如果允许使用制表符,那么要确保团队成员维护彼此的代码时,不会影响代码的清晰和可读性。
  • 如果不允许使用制表符,应该允许编译器在读入源文件时将空格转换为制表符,使用户能够在编辑器中使用制表符,但是在将文件写回时,一定要将制表符转换回空格。
例3 匈牙利记法

将变量信息并入变量名的记法,是混用了类型不安全语言(特别是C)中的设施,这在面向对象语言中是可以存在的,但是有害无益,在泛型编程中则根本不可行。
所以,任何C++编程规范都不应该要求使用匈牙利记法,而在规范中选择禁用该法则是合理的。

例4 单入口,单出口(SESE,Single Entry Single Exit)

历史上,有些编程规范曾经要求每个函数都只能有一个出口,也就意味着只能有一个return语句。这种要求对于支持异常和析构函数的语言而言已经过时了,在这样的语言中,函数通常都有多个隐含的出口。取而代之,应该直接提倡更简单的、更短小的函数,这样的函数本身更易于理解,更容易防错。

相关文章推荐

《C++编程规范-101条规则 准则与最佳实践》读书笔记

组织和策略问题 第0条 不要拘泥于小节(又名:了解哪些东西不应该标准化)    无需在多个项目或者整个公司范围内强制实施一致的编码格式。 第1条 在高警告级别干净利落地进行编译    高度重视警告:使...

C++编程规范(101条规则、准则与最佳实践)

C++编程规范(101条规则、准则与最佳实践) 虽然是书本的目录,但也是高度的概括和总结。  组织和策略问题 第0条:不要拘泥于小节(了解哪些东西不应该标准化) 第1 条:在高警告级别干净利落...

《C++编程规范:101条规则、准则与最佳实践》

 《C++编程规范:101条规则、准则与最佳实践》学习笔记 博客分类: 学习笔记转载整理C/C++学习 0. 不要为小事斤斤计较。(或者说是:知道什么东西不需要标准化) ...
  • wyl4138
  • wyl4138
  • 2016年04月13日 20:59
  • 317

Google C++Style Guide【C++编程风格指南解读】——Windows代码规则

Windows 程序员有自己的编程习惯, 主要源于 Windows 头文件和其它 Microsoft 代码. 我们希望任何人都可以顺利读懂你的代码, 所以针对所有平台的 C++ 编程只给出一个单独的指...

C++编程准则(2)

16.        注意长的参数表,这样的函数调用会难写、难读、难于维护。应该把这个函数改成一个合适的类,用对象作为参数传递。 17.        不要自我重复。如果一段代码在派生类的许多函数中...
  • Nancy_m
  • Nancy_m
  • 2012年05月23日 16:05
  • 408
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:《C++编程规范——101条规则、准则与最佳实践》笔记000
举报原因:
原因补充:

(最多只允许输入30个字)