关于c++:C注释的常见用法

39次阅读

共计 526 个字符，预计需要花费 2 分钟才能阅读完成。

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

单行正文：//
```
//
```
多行正文：/ ….. /
```
/*    

*/
```

文件头的标注

/**
 *  @file     Example.h                                                                             * 
 *  @brief    对文件的简述                                                                              *
 *  Details.                                                                                         *
 *                                                                                                   *              
 *  @author   XX.xx                                                                                  *
 *  @email    example@126.com                                                                      *  
 *  @version  1.2.3.1(版本号)                                                                       *
 *  @date     example@126.com                                                                       * 
 *  @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);

正文完