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

DocBlockr 2021 (由 DoxyDoxygen 驱动)

由 20Tauri ALL

为50多种语言和15多个文档工具（包括Doxygen、JsDoc3、PhpDoc）创建、更新、翻译注释。本版的 DoxyDoxygen 包含了一些常规版本中没有的 DocBlockr 快捷方式。

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

详细信息

安装

  • 总数 21K
  • Win 15K
  • Mac 4K
  • Linux 3K
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 0 1 2 1 3 1 2 0 3 2 1 1 1 2 1 1 4 2 1 0 3 3 0 1 1 0 0 0 1 2 2 1 4 1 0 0 0 1 0 6 0 0 0 3 2 1
Mac 1 1 1 0 0 0 1 0 0 0 1 1 1 1 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 1 0 1 1 1 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 2 0 0 0 2 0 1 0 0 0 1 0 0 0 0 0 1 1 0 0 0 0 0 0 2 0 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0

Readme

源代码
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命令（使用Sublime Text默认按键绑定按F12）从@ref标签移动到引用的页面或部分。

折叠/展开注释

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

在Windows和Linux上

  • Ctrl+Shift+[: 折叠
  • Ctrl+Shift+]: 展开不正确

在OS X上

  • Super+Alt+[: 折叠
  • Super+Alt+]: 展开不正确

翻译

警告

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

要翻译选区，请前往命令面板（《Ctrl》+《Shift》+《P》），然后选择DoxyDoxygen：翻译或DoxyDoxygen：转到翻译来翻译它们。

提示

如果光标在一个评注块中（没有选择），则会翻译这个评注的所有描述。

生成文档

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

注意

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