C++注释规范

 

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. }; 

 

让人迷茫的原因只有一个,那就是在本该拼搏的年龄,却想的太多,做的太少!!!
 
 
posted @   jiftle  阅读(965)  评论(0编辑  收藏  举报
编辑推荐:
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
· 没有源码,如何修改代码逻辑?
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
阅读排行:
· 在鹅厂做java开发是什么体验
· 百万级群聊的设计实践
· WPF到Web的无缝过渡:英雄联盟客户端的OpenSilver迁移实战
· 永远不要相信用户的输入:从 SQL 注入攻防看输入验证的重要性
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
点击右上角即可分享
微信分享提示