C++注释的常见用法

Posted 2021-09-24 休息休息接着来

C++注释的常见用法

本文参考：https://www.cnblogs.com/aspir...

1. 基本用法

• 单行注释： //

  //

• 多行注释： / ..... /

  /*    
  
  */

2. 几种常见的注释规范

• 文件头的标注

  /**
   *  @file     Example.h                                                                             * 
   *  @brief    对文件的简述                                                                              *
   *  Details.                                                                                         *
   *                                                                                                   *              
   *  @author   XX.xx                                                                                  *
   *  @email    [e-mail]                                                                      *  
   *  @version  1.2.3.1(版本号)                                                                       *
   *  @date     [e-mail]                                                                       * 
   *  @license  GNU General Public License (GPL)                                                       *
   */

• 命名空间的标注

  /**
   * @brief 命名空间的简单概述 \\n(换行)
   * 命名空间的详细概述
   */
  namespace example
   {
   }

• 类的标注

  /**
   * @brief 类的简单概述 \\n(换行)
   * 类的详细概述
   */
  class example
   {
   };

• 函数的标注

  /** 
   * @brief 函数简要说明-测试函数
   * @param index    参数1
   * @param t        参数2 @see CTest
   *
   * @return 返回说明
   *     -<em>false</em> fail
   *     -<em>true</em> succeed
   */
  bool example(int index, const CTest& t);