Doxygen和VS助手配置代码注释模板

Title:FileNote
Shortcut:#filenote
Description:文件注释
/**
*  Copyright (c) $YEAR$, xx科技有限公司(http://blog.csdn.net/stelalala)
*  All rights reserved.
*
*  @file        $FILE_BASE$.$FILE_EXT$
*  @author      张三(zhangsan@xx.com)
*  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
*
*  @brief       $brief$
*  @note        无
*
*  @version
*    - v$VerNO$    $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    张三    $VerNoBrief$
*/
说明:新文件版本添加到已有版本的前面,格式如后面的“新版本说明”

Title:ClassNote
Shortcut:#classnote
Description:类注释
/**
*  @author      张三(zhangsan@xx.com)
*  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
*  @class       $classname$
*  @brief       $brief$
*  @note        无
*/

Title:FuntionNote
Shortcut:#funnote
Description:函数注释
    /**
    *  @date        $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$
    *  @brief       $brief$
    *  @param[in]   
    *  @param[out]  
    *  @return      成功返回true,否则为false
    *  @pre         
    *  @remarks     
    *  @see         
    */
说明:如果没有对应信息,可将部分字段删除。私有成员函数建议去掉最后三个字段。

Title:MemberNote
Shortcut:#memnote
Description:结构体、枚举、成员变量等注释
/** $VariableNote$ */	放在被注释对象上面
/**< $VariableNote$ */	放在被注释对象后面

Title:NewVerBrief
Shortcut:#newver
Description:新版本说明
*    - v$VerNo$    $YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    张三    


Title:date
Shortcut:#date
Description:获取当前时间
$YEAR$/$MONTH_02$/$DAY_02$ $HOUR_02$:$MINUTE$    

参考资料:
1、 通过vc助手设置快捷注释
2、 在Visual Assist X中增加Doxygen格式的注解的模板 [RT,修改]
3、 Doxygen详细介绍(三)(Doxygen注释风格)
4、 Doxygen风格注释类、成员、函数
5、 本博客其他关于Doxygen的介绍
  • 0
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值