给代码写注释时有哪些讲究?
数学算法俱乐部
共 2545字,需浏览 6分钟
·
2021-02-17 20:08
日期 : 2021年02月17日
正文共 :2051字
整理/来源:strongerHuang
//
或 /* */
,只要统一就好。//
或 /* */
都可以,但团队要在如何注释及注释风格上确保统一。.h
文件声明了多个概念, 则文件注释应当对文件的内容做一个大致的说明, 同时说明各概念之间的联系。一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。.h
和 .cc
之间复制注释, 这样的注释偏离了注释的实际意义。/************************************************************************
*
* Copyright Copyright 2020 Google Inc.
* File Name: 文件名
* Description: 描述
*
* Version: V1.0
* Author: Your_Name
* Create Time: 2020-01-01
*
*************************************************************************/
/************************************************************************
*
* 函 数 名:函数名
* 函数功能:功能描述
* 输入参数:void
* 输出参数:void
* 返 回 值: void
*
* 作 者:Your_Name
* 创建时间:2020-01-01
* 其他说明:无
* 修改信息:无
*
************************************************************************/
.h
文件或其他地方的函数声明处直接复制注释. 简要重述函数功能是可以的, 但注释重点要放在如何实现上。TODO
注释。TODO
注释要使用全大写的字符串 TODO
, 在随后的圆括号里写上你的名字, 邮件地址, bug ID, 或其它身份标识和与这一 TODO
相关的 issue。主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的 TODO
格式进行查找。添加 TODO
注释并不一定意味着你要自己来修正, 因此当你加上带有姓名的 TODO
时, 一般都是写上自己的名字。— THE END —
评论