Difference between revisions of "C++代码风格指南"

From KlayGE
Jump to: navigation, search
Line 14: Line 14:
  
 
注意,本指南不是个C++教程。我们假设读者熟悉这门语言。
 
注意,本指南不是个C++教程。我们假设读者熟悉这门语言。
 +
 +
= 头文件 =
 +
 +
= 范围 =
 +
 +
= 类 =
 +
 +
= 写短函数 =
 +
 +
= 其他C++特性 =
 +
 +
= 命名 =
 +
 +
= 注释 =
 +
 +
= 格式 =
 +
 +
= 这些规则的例外情况 =
 +
 +
= 结语 =
  
 
[[en:C++ style guide]]
 
[[en:C++ style guide]]

Revision as of 10:48, 2 May 2012

当前页面的内容正在依照C++ style guide的内容进行翻译。如果您熟知页面内容并擅长翻译,欢迎协助改善或校对此页面

背景

C++是KlayGE使用的主要编程语言。每个C++程序员都知道,这个语言有着很多强大的特性,但强大的同时也带来了各种复杂性。结果就是更容易出bug,并且难以阅读和维护。

本指南将详细描述各种在写C++代码的过程中该做和不该做的事情,以达到控制复杂性的目的。这些规则一方面让代码库便于管理,另一方面允许开发者高效地使用C++的语言特性。

风格,也称为可读性,是掌控我们C++代码的规则。风格这个术语也许有些不当,因为这些规则远远超过了源代码格式的范畴。

我们管理代码库的一种方式是强制保持一致性。让任何开发者可以很快地看懂和明白其他人的代码非常重要。维护一个统一的风格并遵循规则,意味着我们可以更容易地使用“模式匹配”来推断各种符号是什么意思,以及有哪些不变性。建立一个通用的、必需的范式和模式会让代码容易理解得多。在某些情况下,可能会有很好的理由需要改变一些风格的规则,但为了保证一致性,我们仍然需要保持规则不变。

本指南要解决的另一个问题是应对C++的特性膨胀。C++是一个巨大的语言,有着许多先进特性。有些时候我们约束、甚至禁止使用一些特性。我们这么做可以保持代码简单易懂,并避免那些特性可能带来的多种常见错误和问题。本指南列出了这些特性,并解释为什么要限制使用他们。

注意,本指南不是个C++教程。我们假设读者熟悉这门语言。

头文件

范围

写短函数

其他C++特性

命名

注释

格式

这些规则的例外情况

结语