ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

DoxyDoxygen

作者： 20Tauri 全部

使注释更加简单。支持Doxygen，JsDoc3，PhpDocumentor...

标签 文档， 注释， 自动完成， 代码片段， 翻译， 格式化

详细信息

安装

  • 总数 38K
  • Win 19K
  • Mac 8K
  • Linux 11K
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日 6月22日
Windows 1 1 0 3 3 4 0 5 2 0 0 2 1 2 2 3 0 1 3 1 1 3 2 0 1 2 5 2 3 2 0 2 1 1 3 2 0 2 2 0 0 0 0 0 0 3
Mac 4 1 0 0 0 1 1 0 1 0 0 1 4 0 3 0 0 1 1 1 1 0 0 0 0 2 2 0 0 1 0 0 1 0 1 2 0 0 0 1 0 0 0 1 0 0
Linux 1 0 1 1 2 3 1 3 1 0 2 4 0 0 1 1 1 2 0 0 3 2 1 0 1 3 2 2 2 1 0 1 2 2 1 1 0 1 1 1 0 1 0 1 2 0

说明文档

源代码
raw.githubusercontent.com

欢迎使用DoxyDoxygen

DoxyDoxygen是Sublime Text的一个插件，主要用于提高在源代码中创建和更新文档注释的效率。

它如何工作？

  • 编写代码
  • 按 Alt+Q（或键入/**然后按Enter），代码将被解析并为你生成文档骨骼
  • 更新代码
  • 按 Alt+Q，文档将被更新

DoxyDoxygen可以轻松配置以适应您的需求。

生成文档…描述会使用您本地的语言编写…

并且，阅读这份手册您会发现更多功能，比如按需翻译…

用法

创建文档块

在一个声明之前开始文档块（通常为/**），然后按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命令从@ref标签跳转到引用的页面或部分（使用Sublime Text默认快捷键按F12）。

折叠/展开注释

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

在Windows和Linux上

  • Ctrl+Shift+[: 折叠
  • Ctrl+Shift+]: 展开内容

在OS X上

  • Super+Alt+[: 折叠
  • Super+Alt+]: 展开内容

翻译

警告

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

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

提示

如果光标在注释块中（没有选择），则将翻译此注释的所有内容。

生成文档

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

注意

在命令执行之前，DoxyDoxygen将解析Doxyfile文件，并提取所有标题@INCLUDE。对于每个包含的文件，都会生成一个环境变量。这个变量的名字是：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可以免费下载和评估，但为了继续使用，必须购买许可证。有关更多信息，请参阅最终用户许可协议。