Title:FileNote
Shortcut:#filenote
Description:文件注释
/**
* Copyright (c) $YEAR$, xx科技有限公司(http://blog.csdn.net/stelalala)
* All rights reserved.
*
* @file $FILE_BASE$.$FILE_EXT$
* @author 张三([email protected])
* @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 张三([email protected])
* @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的介绍