注释规范

文件注释

                @file - 文件名
                       @author - 作者
                       @version - 版本
                       @date - 日期
               @note - 注解

函数注释
                    @brief - 简短说明
                 @param - 输入参数
                 @arg - 输入参数取值
                 @return - 返回值
                 @retval - 返回值取值

               @sa -参考资料(see also)

@code -在文档当中嵌入代码块,代码结尾处使用@endcode标签

@addtogroup、@{、@}添加到一个分组,如果分组不存在,自动创建
@todo  -将要做的事

@since - 从哪个版本起有了这个函数

  多行注释:/**
                    *
                    */

单行注释:///


根据Doxygen生成帮助文档。

命名空间:禁止使用 using 指示 引入整个命名空间的标识符号(污染命名空间),在命名空间的最后注释出命名空间的名字


你可能感兴趣的:(注释规范)