使用Visual Assist X进行快捷doxygen模板注释
2015-04-08 23:03
696 查看
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言。使用doxygen方式注释,可以生成HTML及chm等格式的开发文档。
利用assistX工具,可以设置doxygen模板,快捷地生成代码注释。
安装好Visual Assist X后,打开VC开发工具。这里以VS2010为例。点击Visual Assist X Options,即工具栏上的番茄图标或菜单栏VassistX-Visual Assist X Options,会弹出设置对话框,点击Suggestions-Edit VA Snippets,如下图:
新建自定义的模板。
Shortcut: //M
/**
* @brief Thisis a brief description.
* @param[in] inArgName input argument description.type name:purpose(Range)
* @param[out] outArgName output argument description.
* @Return: $SymbolType$:description of the return value
* - TRUE
* - FALSE
*
* @note matters needing attention
* @see other functions
*/
Title: doxyen file header
Shortcut: //F
/**
* @file $FILE_BASE$.$FILE_EXT$
* @brief Thisis a brief description.
* @author $Author$
* @par Copyright (c):
* $Author$.
* All Rights Reserved
* @date $YEAR$:$MONTH_02$:$DAY_02$
* @note mattersneeding attention
* @version <version number>
*/
Title: doxyen class
Shortcut: //C
/**
* @class <class‐name>
* @brief This is a brief description.
* @note mattersneeding attention
*/
类成员注释:
int var; ///< Brief description after the member
枚举类型注释:
/** @brief
This is a brief description. */
enum XXXEnum
{
V1, /**< value 1 */
V2 /**< value 2 */
};
全局变量及宏注释:
/** @brief some brief description */
int g_Var;
或
#define XXXX_XX ///< some brief description。
此处同时附上其他常用的doxygen命令列表:
@exception 用来说明异常类及抛出条件
@deprecated 已废弃函数
@details 详细描述
@par 开始一个段落,段落名称描述由你自己指定
@code .. @endcode 包含一段代码
@fn 函数说明
@retval 描述返回值意义
@include 包含文件
@note 表示注解,暴露给源码阅读者的文档
@remark 表示评论,暴露给客户程序员的文档
最后的效果图如下:
利用assistX工具,可以设置doxygen模板,快捷地生成代码注释。
安装好Visual Assist X后,打开VC开发工具。这里以VS2010为例。点击Visual Assist X Options,即工具栏上的番茄图标或菜单栏VassistX-Visual Assist X Options,会弹出设置对话框,点击Suggestions-Edit VA Snippets,如下图:
新建自定义的模板。
1. 函数注释模板。
Title: doxyen methodShortcut: //M
/**
* @brief Thisis a brief description.
* @param[in] inArgName input argument description.type name:purpose(Range)
* @param[out] outArgName output argument description.
* @Return: $SymbolType$:description of the return value
* - TRUE
* - FALSE
*
* @note matters needing attention
* @see other functions
*/
2.头文件注释模板
在assistX中设置的方法与函数注释模板类似。Title: doxyen file header
Shortcut: //F
/**
* @file $FILE_BASE$.$FILE_EXT$
* @brief Thisis a brief description.
* @author $Author$
* @par Copyright (c):
* $Author$.
* All Rights Reserved
* @date $YEAR$:$MONTH_02$:$DAY_02$
* @note mattersneeding attention
* @version <version number>
*/
3.类文件注释模板
在assistX中一般设置。Title: doxyen class
Shortcut: //C
/**
* @class <class‐name>
* @brief This is a brief description.
* @note mattersneeding attention
*/
4.其他doxygen注释
由于注释都比较简单,就无需放assistX中设置成模板了。类成员注释:
int var; ///< Brief description after the member
枚举类型注释:
/** @brief
This is a brief description. */
enum XXXEnum
{
V1, /**< value 1 */
V2 /**< value 2 */
};
全局变量及宏注释:
/** @brief some brief description */
int g_Var;
或
#define XXXX_XX ///< some brief description。
此处同时附上其他常用的doxygen命令列表:
@exception 用来说明异常类及抛出条件
@deprecated 已废弃函数
@details 详细描述
@par 开始一个段落,段落名称描述由你自己指定
@code .. @endcode 包含一段代码
@fn 函数说明
@retval 描述返回值意义
@include 包含文件
@note 表示注解,暴露给源码阅读者的文档
@remark 表示评论,暴露给客户程序员的文档
最后的效果图如下:
相关文章推荐
- Visual Assist X 中使用doxygen的模板注释
- 使用Visual Studio扩展插件Visual assist X给代码插入注释模板
- 使用Visual Studio扩展插件Visual assist X给代码插入注释模板
- 番茄助手Visual Assist X的简单使用以及消除中文注释警告
- Visual Assist X添加注释模板
- 在Visual Assist X中增加Doxygen格式的注解的模板 [RT,修改]
- visual studio扩展插件Visual Assist x给代码插入注释模板(转载)
- Visual Assist X尽量避免在非英文目录下使用,否则可能由于文件路径不能识别而导致不能进行提示
- 在Visual Assist X中增加Doxygen格式的注解的模板 [RT,修改]
- 使用 Visual Assist X 自动添加注释及常用代码
- 使用va(Visual Assist X)快速添加注释 + 快捷键
- Visual Assist X尽量避免在非英文目录下使用,否则可能由于文件路径不能识别而导致不能进行提示
- 使用 WebSphere Studio Application Developer 开发 Java 程序: 与 VisualAge for Java 进行比较
- 使用Microsoft visual Studio和Rational Purify进行运行时调试(二)
- ECLIPSE用VE进行RCP开发2:使用Eclipse的VE(Visual Editor)
- 在Visual Studio 2003中使用最新的Visual Assist X 10.3.1541(修正下载地址)
- 使用 DB2 Visual Studio 2005 Add-in 进行带注释的 XML 模式分解
- 演练:使用 Visual Studio Team Test 进行单元测试
- vs.net web项目使用visual source safe进行源代码管理
- 使用 Visual Basic .NET 进行多线程编程