Visual C++ 的改进方法文档

• 下载源代码 - 45 Kb
• 下载演示项目 - 23 Kb

引言

在我的上一篇文档文章 Visual C++ 6 的方法文档实用工具 中，我收到了一些评论，说该插件不支持 Doxygen 格式。 事实上，它根本不支持任何格式，完全是硬编码的。

这个新的插件允许用户通过一个简单的配置屏幕来决定文档的格式。 默认格式将是 Doxygen。

描述

和之前的插件一样，你可以按下工具栏上的按钮（或你分配给它的任何快捷键），文档框架将出现在方法/函数之上。 文档将包含以下部分

• 通用 – 方法的通用描述
• 返回值 – 解释将要返回的值
• 参数 – 可以记录任何参数
• 参见 – 对另一个方法或代码部分的引用
• 文档开始 – 文档的开始
• 文档结束 – 文档的结束

大多数人都知道的 Doxygen 格式，也是该插件的默认格式，如下所示

//! Method description
/*!
\param nF - description
\param nS - description
\return bool - description
\sa func2()
*/
bool func(int nF, int nS);

还有其他格式，但我选择了这个，因为我习惯了它。

要生成文档，你只需要将光标放在方法之前的一行或与方法相同的行，如下所示

[Cursor Here] 
bool func(int nF, int nS); 

然后按下插件的左按钮或你选择的键盘快捷键。

插件提取方法的文本。 它从光标下一行开始，收集文本直到到达 ‘)’。 然后它解析文本。 目前我只解析返回值和参数列表。 如果需要其他信息，例如：virtual/const，将会添加到工具中。

自定义文档

自定义对话框如下所示

要打开此屏幕，只需按下插件的右按钮。

在这里你可以更改文档的模板。 它基于标签，每个标签代表文档中的不同元素

参数、返回值…

要更改标签的值，只需选择标签并在底部的文本框中输入你自己的文本。 右侧的框会向你展示文档的外观示例。

安装插件

要安装二进制文件并在 Visual C++ 6 下使用它，请阅读两个 zip 文件中添加的 Readme.txt 文件

该代码仅在 Windows2000/XP 下进行了测试，它可能在 windows 98 下工作，但谁能确定…