Google C++Style Guide【C++编程风格指南解读】——注释

孟浩慨
2023-12-01

注释虽然写起来很痛苦, 但对保证代码可读性至关重要. 下面的规则描述了如何注释以及在哪儿注释. 当然也要记住: 注释固然很重要, 但最好的代码本身应该是自文档化. 有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字.


1:使用 // 或 /* */, 统一就好.

解读:个人觉得//会比较方便一点~


2:在每一个文件开头加入版权公告, 然后是文件内容描述.

解读:

每个文件都应该包含以下项, 依次是:

1:版权声明 (比如, Copyright 2008 Google Inc.)
2:许可证. 为项目选择合适的许可证版本 (比如, Apache 2.

 类似资料: