zoukankan      html  css  js  c++  java
  • 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. }; 
  • 相关阅读:
    hdu4597 Play Game DP
    poj2253 Frogger Dijkstra变形
    poj1797 Heavy Transportation Dijkstra算法的简单应用
    49.将手机收藏信息保存到文件中
    48.XML保存衣服尺码信息
    47.多客户端用户登录
    46. 模拟用户登录的功能
    45.客户咨询问题
    44. 客户端发送信息给服务器端
    43.创建线程的两种方法
  • 原文地址:https://www.cnblogs.com/liujiaknowledge/p/5367720.html
Copyright © 2011-2022 走看看