Google c++编程规范------注释
在我写一起学 c++( 二 ) 中说道注释的重要性,特意找了 Google c++ 编程规范给大家参考。希望能对大家有所帮助,并且在以后为大家继续更新相应的规范要求 注释虽然写起来很痛苦,但对保证代码可读性至为重要,下面的规则描述了应该注释什么、 注释在哪儿。当然也要记住,注释的确很重要,但最好的代码 本身就是文档( 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 ) :标识文件的原始作者。