码迷，mamicode.com
首页 > 编程语言 > 详细

C++注释规范

时间：2016-04-08 14:29:06      阅读：212      评论：0      收藏：0      [点我收藏+]

标签：

1 源文件头部注释

  • 列出：版权、作者、编写日期和描述。
  1. /************************************************* 
  2. Copyright:bupt 
  3. Author: 
  4. Date:2010-08-25 
  5. Description:描述主要实现的功能 
  6. **************************************************/  

 

 

每行不要超过80个字符的宽度。

2 函数头部注释

/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

  1. /************************************************* 
  2. Function:       // 函数名称 
  3. Description:    // 函数功能、性能等的描述 
  4. Calls:          // 被本函数调用的函数清单 
  5. Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序） 
  6. Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） 
  7. Input:          // 输入参数说明，包括每个参数的作 
  8.                   // 用、取值说明及参数间关系。 
  9. Output:         // 对输出参数的说明。 
  10. Return:         // 函数返回值的说明 
  11. Others:         // 其它说明 
  12. *************************************************/  

 

3 数据结构声明的注释(包括数组、结构、类、枚举等)

如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。

 

  1. /* sccp interface with sccp user primitive message name */  
  2. enum SCCP_USER_PRIMITIVE  
  3. {  
  4.     N_UNITDATA_IND, /* sccp notify sccp user unit data come */  
  5.     N_NOTICE_IND,   /* sccp notify user the No.7 network can not */  
  6.                     /* transmission this message */  
  7.     N_UNITDATA_REQ, /* sccp user‘s unit data transmission request*/  
  8. }; 

 

C++注释规范

标签：

原文地址：http://www.cnblogs.com/liujiaknowledge/p/5367720.html
踩
(0)
赞
(0)
   
举报
评论 一句话评论（0）
登录后才能评论！
分享档案
更多>
2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)
周排行
mamicode.com排行更多图片
更多
友情链接
兰亭集智   国之画   百度统计   站长统计   阿里云   chrome插件   新版天听网
关于我们 - 联系我们 - 留言反馈
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码！