DoxyDoxygen (进化)

作者： 20Tauri 所有

在所有人之前获得最新的 DoxyDoxygen 进化，并帮助创造未来。

详细信息

版本 1.0.1
主页 20tauri.free.fr
问题 github.com
购买 20tauri.free.fr
修改 6 个月前
最后看到 2 小时前
首次看到 9 年前

安装

总计 4K
Win 2K
Mac 728
Linux 1K

	8 月 6 日	8 月 5 日	8 月 4 日	8 月 3 日	8 月 2 日	8 月 1 日	7 月 31 日	7 月 30 日	7 月 29 日	7 月 28 日	7 月 27 日	7 月 26 日	7 月 25 日	7 月 24 日	7 月 23 日	7 月 22 日	7 月 21 日	7 月 20 日	7 月 19 日	7 月 18 日	7 月 17 日	7 月 16 日	7 月 15 日	7 月 14 日	7 月 13 日	7 月 12 日	7 月 11 日	7 月 10 日	7 月 9 日	7 月 8 日	7 月 7 日	7 月 6 日	7 月 5 日	7 月 4 日	7 月 3 日	7 月 2 日	7 月 1 日	6 月 30 日	6 月 29 日	6 月 28 日	6 月 27 日	6 月 26 日	6 月 25 日	6 月 24 日	6 月 23 日
Windows	0	0	0	1	1	0	1	0	0	0	0	0	1	3	0	0	0	0	0	0	0	1	0	0	1	0	2	0	2	0	0	0	0	2	1	1	0	0	1	1	0	0	0	0	0
Mac	1	1	0	0	0	0	0	0	0	0	0	0	2	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	1	0
Linux	0	0	0	0	1	0	0	0	0	0	1	0	0	0	2	0	0	0	0	0	1	0	0	0	1	0	0	1	1	0	0	0	1	0	0	0	1	0	0	0	0	0	0	1	0

读我

源代码: raw.githubusercontent.com

欢迎使用 DoxyDoxygen

DoxyDoxygen 是 Sublime Text 的插件，旨在在创建和更新源代码中的文档注释时节省大量时间和精力。

它是如何工作的？

编写代码
按 Alt+Q（或 /** + Enter），解析代码并为您编写骨架文档
更新代码
按 Alt+Q，更新文档

DoxyDoxygen 可以很容易地进行配置以满足您的需求。

无论您的编程语言
无论您的文档生成器：ApiDoc，AsDoc，Doxygen，Drupal Api 模块，Google Closure，JavaDoc，JsDoc，PhpDocumentor，SassDoc，Sphinx，XmlDoc，YuiDoc...
无论您的注释风格：/**，///…
无论您喜欢的标签布局

生成的文档… 描述以您的母语编写…

此外，通过阅读本手册，您还将发现更多功能，如按需翻译…

用法

创建文档块

在一个声明之前启动文档块（通常是 /**），然后按 Enter 键。相应的文档将自动插入。无需记住任何键盘快捷键。

为了提高效率，您也可以在函数定义后按 Alt+Q（或在 OS X 上按 Super+Alt+Q）键。系统为您写入文档块。

类型会自动从代码中推断出来

即使是难以分析的编程语言也得到了适当的支持

如果函数有模板参数，则会自动添加一个 @tparam 属性

当然，类（无论是否有模板）也得到支持。

更新/包装现有文档块

要更新注释，请按 Alt+Q（或在 OS X 上按 Super+Alt+Q）。由于 DoxyDoxygen 了解 Doxygen 命令，因此不会插入无效的换行符。

更好的是，在默认设置下，Alt+Q 还会重新检查文档化的对象，并检测缺失、重命名或移动的参数

DoxyDoxygen 会保留具有层次结构的列表。在更新时，保持在项目前面的空格。一个有效的列表项是以 -#、-、+ 或 * 开头的行。

有效列表的示例

/**
 * @return Error code
 *           - E_OK
 *           - E_ACCESS_DENIED
 *           - E_INTERNAL
 */

无效列表的示例

/**
 * @return Error code:
 *           E_OK
 *           E_ACCESS_DENIED
 *           E_INTERNAL
 */

更新后的无效列表

/**
 * @return Error code: E_OK E_ACCESS_DENIED E_INTERNAL
 */

在注释样式之间切换

要切换首选的注释样式，请按 Shift+Alt+Q（或在 OS X 上按 Super+Shift+Alt+Q）。

您也可以在 命令面板 中找到更多灵活的命令。

扩展文档块

自动补全

DoxyDoxygen 允许自动补全。有一大套命令可供使用，

可用的命令取决于文档样式

只有与您配置的文档样式匹配的命令才会被建议。

例如，要获取可用命令列表，请按 @。然后，按 Ctrl+Space 以显示完成列表。

Ctrl+Space 是可选的，但 Sublime Text 默认设置将取消注释中的补全（请参阅 auto_complete_selector 设置）。

注释续行

如在之前的示例中所见，连续按 Enter 键可以自动续行注释。

警告

对于单行注释，注释续行在最后一行注释（例如 ///）中可能会显得奇怪。该行为是可选的（请参阅参数 continuation_on_last_comment）。如果已启用，可以按 Shift+Enter 来停止续行。

在文档中导航

移动到右侧列

为了便于导航，请按 End 键（在 OS X 上按 Super+Right）以跳转到下一列。

跟踪引用

警告

仅限 Doxygen 文件（.dox）

您可以使用 goto_definition 命令（使用 Sublime Text 默认密钥绑定按 F12）从 @ref 标签移动到所引用的页面或部分。

折叠/展开注释

您可以从 命令面板 或使用 Sublime Text 的标准快捷键折叠/展开注释块。

在 Windows 和 Linux 上

Ctrl+Shift+[ 折叠
Ctrl+Shift+] 展开对齐

在 OS X 上

Super+Alt+[ 折叠
Super+Alt+] 展开对齐

翻译

警告

翻译使用网络服务。如果您位于代理之后，请在使用这些功能之前配置它。

要翻译选择的内容，请转到 命令面板（按 Ctrl+Shift+P），然后选择 DoxyDoxygen: Translate 或 DoxyDoxygen: Translate To 以进行翻译。

提示

如果光标位于注释块中（没有选择），则会翻译该注释的所有描述。

生成文档

如果您使用Doxygen，可以直接从命令面板中生成文档。助手将帮助您下载工具和配置项目。

备注

在执行命令之前，DoxyDoxygen首先解析Doxyfile文件并提取所有标题。对于每个包含的文件，生成一个环境变量s。该变量的名称是：DOXYDOXYGEN_GENERATED_<base_name_without_extension>_PATH，其值是文件存储路径。这允许在每个包含文件内部进行相对包含（对于页脚很有用）。

如果文件名包含非字母数字字符，则它们将被_替换。

../path/filename.ext定义一个名为DOXYDOXYGEN_GENERATED_FILENAME_PATH的变量，其值为../path。

path/A@STRANGE!VALUE.ext定义一个名为DOXYDOXYGEN_GENERATED_A_STRANGE_VALUE_PATH的变量，其值为path。

提示

如果您想将其包含在构建链中，您可以从命令行调用此命令。

用户指南

支持

许可证

DoxyDoxygen可以免费下载和评估，但是必须购买许可证才能继续使用。有关更多信息，请参阅最终用户许可协议。

Doxy​Doxygen (进化)