注释

　　注释虽然写起来很痛苦，但对保证代码可读性至为重要，下面的规则描述了应该注释什么、注释在哪儿。当然也要记住，注释的确很重要，但最好的代码本身就是文档（self-documenting），类型和变量命名意义明确要比通过注释解释模糊的命名好得多。

　　注释是为别人（下一个需要理解你的代码的人）而写的，认真点吧，那下一个人可能就是你！

　　1. 注释风格（Comment Style）

　　使用//或/* */，统一就好。

　　//或/* */都可以，//只是用的更加广泛，在如何注释和注释风格上确保统一。

　　2. 文件注释（File Comments）

　　在每一个文件开头加入版权公告，然后是文件内容描述。

　　法律公告和作者信息：

　　每一文件包含以下项，依次是：

　　1) 版权（copyright statement）：如Copyright 2008 Google Inc.；

　　2) 许可版本（license boilerplate）：为项目选择合适的许可证版本，如Apache 2.0、BSD、LGPL、GPL；

　　3) 作者（author line）：标识文件的原始作者。

　　如果你对其他人创建的文件做了重大修改，将你的信息添加到作者信息里，这样当其他人对该文件有疑问时可以知道该联系谁。

　　文件内容：

　　每一个文件版权许可及作者信息后，都要对文件内容进行注释说明。

　　通常，.h文件要对所声明的类的功能和用法作简单说明，.cc文件包含了更多的实现细节或算法讨论，如果你感觉这些实现细节或算法讨论对于阅读有帮助，可以把.cc中的注释放到.h中，并在.cc中指出文档在.h中。

　　不要单纯在.h和.cc间复制注释，复制的注释偏离了实际意义。

　　3. 类注释（Class Comments）

　　每个类的定义要附着描述类的功能和用法的注释。

// Iterates over the contents of a GargantuanTable. Sample usage:
// GargantuanTable_Iterator* iter = table->NewIterator();
// for (iter->Seek("foo"); !iter->done(); iter->Next()) {
// process(iter->key(), iter->value());
// }
// delete iter;
class GargantuanTable_Iterator {
...
};