【规范】C/C++注释格式

1. 文件

 

/******************************************************************************************************************
* Copyright (C): 本代码所有版权为ysq所有，任何个人或者组织不得以任何方式复制、转载以挪作他用，否则将构成对ysq的产权知识侵权。
* @file       : Command.h
* @brief      : // 对该文件的解析
* @autor      : Ysq
* @emil:      : 694622692@qq.com
* @version    : 1.0.0.0
* @date       : 2019/3/29     00:27     
******************************************************************************************************************/

2. 函数

 

/** 
 * @brief 函数简要说明-测试函数
 * @param index    参数1
 * @param t        参数2 @see CTest
 *
 * @return 返回说明
 *     -<em>false</em> fail
 *     -<em>true</em> succeed
 */

3. 类，结构，枚举标注

 

/**
 * @brief 类的简单概述 \n(换行)
 * 类的详细概述
 */

参考文献

A.R.T.C/C++注释规范.https://www.cnblogs.com/aspiration2016/p/8433122.html

作者：对着天说晚安
链接：https://www.jianshu.com/p/f4dbbecf957c
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。