孔雀开发小屋

专注并致力于手机客户端开发
<2024年11月>
272829303112
3456789
10111213141516
17181920212223
24252627282930
1234567

统计

  • 随笔 - 103
  • 文章 - 0
  • 评论 - 251
  • 引用 - 0

常用链接

留言簿(38)

随笔分类

随笔档案

关注的博客

朋友的博客

搜索

  •  

最新评论

阅读排行榜

评论排行榜

Google C++风格指南笔记(四): 注释

  1. 一致性原则

    // 或者/* */都可以,保持一致即可。

  2. 文件注释

    .h文件对所声明的类的功能和用法作简单说明,.cpp文件包含更多的实现细节。不要在头文件和实现文件中简单的复制注释,那就失去了一半的意义。

  3. 函数注释

    头文件中描述函数功能,定义处描述功能实现。

  1. 变量注释

    成员变量、全局变量都一样,说明其用途即可。

  1. 注意拼写和语法

    错误的语法,错误的拼写给他人带来困惑与不快,宁愿不写,不可乱写。

  2. 中文还是英文

    这个看个人喜好,如果英文不过关,就不要硬撑着。注释的本质是帮助别人和帮助自己更好的理解代码,不是炫耀英文或中文水平。


posted on 2011-01-25 18:29 孔雀 阅读(2272) 评论(2)  编辑 收藏 引用 所属分类: C/C++

评论

# re: Google C++风格指南笔记(四): 注释 2011-01-26 21:26 Yulei

我最近也开始研究google的GO了
PS:我的博客变了,http://yestein.com
  回复  更多评论    

# re: Google C++风格指南笔记(四): 注释 2011-02-05 19:58 www.xiegua.com

老大收我做徒弟吧。。。
  回复  更多评论    

只有注册用户登录后才能发表评论。
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理