visual studio snippet常用注释片段

2024-05-15

本文作者原创，首发在本博客；CSDN 上的同名文章已标注为转载并回链到本页：https://blog.csdn.net/qq_30220519/article/details/138914567

Visual Studio 2022 添加自定义代码片段_vs2022 代码片段-CSDN博客

dclass.snippet:

               doxygen类注释模板
               dclass
               类注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[/**
                 * @brief 状态事件执行器，customer作为事件执行的参数
                 * @usage 组件集UI反射更新事件通知eSE_UpdateSGStatusEvent，参数:需要通知反射的UI
                 */
            ]]>

dcode.snippet：

               doxygen行注释模板
               dcode
               代码注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[/// 注释 ///< 注释]]>

ddetail.snippet：

               doxygen详细注释模板
               ddetail
               详细注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[
                /**
                 * @brief 函数简介
                 * @detail 详细说明
                 * 
                 * @param 形参 参数说明
                 * @param 形参 参数说明
                 * @return 返回说明
                 *   @retval 返回值说明
                 * @note 注解
                 * @attention 注意
                 * @warning 警告
                 * @exception 异常
                 */
            ]]>

dfile.snippet：

               doxygen文件注释模板
               dfile
               文件注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[
                /**
                 * @file 文件名
                 * @brief 简介
                 * @details 细节
                 * @mainpage 工程概览
                 * @author 作者
                 * @email 邮箱
                 * @version 版本号
                 * @date 年-月-日
                 * @license 版权
                 */
            ]]>

dfunc.snippet：

               doxygen函数注释模板
               dfunc
               函数注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[
                /*
                 * @brief 获取与给定ID对应的对象.
                 * @param [in] guiId FicGUID
                 * @param [out] guiId FicGUID 
                 * @return 对应的返回说明
                 * @retval 返回值说明
                 */
            ]]>

dother.snippet：

               doxygen其它注释模板
               dother
               其它注释片段
               lp

                   Expansion
                   SurroundsWith

                       name
                       类名
                       MyClass

<![CDATA[
    /**
     * @see 参考
     * @class 引用类
     * @var 引用变量
     * @enum 引用枚举
     * @code 代码块开始
     * @endcode 代码块结束
     * @bug 缺陷
     * @todo TODO
     * @example 使用例子说明
     * @remarks 备注说明
     * @pre 函数前置条件
     * @post       用来说明代码项之后的使用条件。
     * @deprecated 函数过时说明
     * @name       分组名
     * @relates  通常用做把非成员函数的注释文档包含在类的说明文档中。
     * @since      从哪个版本后开始有这个函数的
     * @defgroup   模块名
     * @{          模块开始
     * @}          模块结束
     * @version    版本号
     * @fn         声明一个函数
     * @par        开始一个段落，段落名称描述由你自己指定，比如可以写一段示例代码
     * -           一级项目符号
     * -#          二级项目符号
     */
            ]]>