Google C++代码风格指南翻译简化版(google c++ code style guide)【六】

Google 编程规范本地化、简化。如有需要,可参考 Google C++ code style guide原文:
http://google.github.io/styleguide/cppguide.html

本文档基于网上流传的 Google C++编程风格指南,由 edisonpeng(2009/3/25)整理

本地化简化由MISAS开发团队使用。在此分享以供各开发团队参考。

目录

@[toc]

代码注释

注释风格

说明代码功能的关键注释统一使用 /**/

文件注释

文件注释需说明当前文件在项目中的核心作用

类注释

类的头文件中,对类的成员函数、成员变量做说明。

函数注释

函数申明处注释的内容:
(1)函数作用:当前函数需要达成的目的
(2)函数参数:说明是输入还是输出,及参数含义
(2)返回值:含义和类型

变量注释

变量在当前行的行尾使用 /**/ 注释

实现注释

对逻辑复杂或重要的地方加实现注释。

注意:不要用自然语言翻译代码作为注释,要假定度代码的人C++比你强

标点、拼写和语法

注释要易读

TODO

临时、短期的解决方案,需要使用TODO注释。临时注释使用 //

TODO大写,需要备注作者名,备查找:

//TODO(Luffy):需要优化逻辑

版权声明

弈心博客


本文首发site_name,转载请附上博文链接!