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

DoxyDoc

由 Rapptz 所有

用于C++文档自动完成的Sublime Text插件

标签 自动完成, 片段

详细信息

安装

  • 总计 16K
  • Win 7K
  • Mac 3K
  • Linux 6K
Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23
Windows 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 1 0 1 0 1 1 0 0 0
Mac 1 1 0 0 0 0 0 0 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 0 1 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 1 0 1 0

README

源代码
raw.​githubusercontent.​com

DoxyDoc

DoxyDoc是一个插件，允许您使用Doxygen自动完成C++的doc块注释。受到PhpDoc和DocBlockr的启发，由于DocBlockr缺乏对C++的适当支持，因此此插件得以创建。后一个插件无法解析模板函数或类，并且只会让注释悬空。

没有计划支持其他语言，因为DocBlockr已经很好地完成了这项工作。

安装

通过Package Control安装这个插件是很容易的。

  • 按Ctrl + Shift + P
  • 输入“install”获取“Package Control: Install Package”
  • 输入“DoxyDoc”并会看到这个包。

另一种安装方法是运行您的包目录中的此存储库的git clone。

执行此操作的命令如下

git clone https://github.com/Rapptz/doxydoc.git DoxyDoc

使用方法

就像DocBlockr一样，按下/**然后按回车或制表符会自动插入相应的文档。无需记住任何键盘快捷键。

如你所见，连续按回车会自动继续注释。

DoxyDoc还支持各种形式的C++函数文档。

一个基本函数易于文档化

如果函数有模板参数，将自动添加@tparam属性。

然而，如果函数在函数中使用了模板类型参数，它会尽力不包含它。

如果返回值不是空，DoxyDoc还支持添加@return属性。

DoxyDoc还支持文档化基本类名，无论是模板或非模板的。

请注意，所有这些字段都只是Sublime Text片段，所以在它们之间按制表符会允许您无缝编辑标签的参数。

除了自动生成文档外，DoxyDoc 还允许自动完成一些常见的 Doxygen 片段。如果列出所有支持的片段，将会非常庞大。您可以通过按下 @ 获取一个自动弹出的列表，点击 这里 可以查看所有支持的片段。

尽管如此，DocBlockr 仍有一些缺陷，您可以在下面的 TODO 中找到。

问题和局限

C++ 解析非常困难，因此宣称这种所谓的解析器完全完美是荒谬的。偶尔的故障肯定会时不时地出现，这就是为什么我让它尽可能简单。由于“解析器”本质上是一系列正则表达式，因此由于我选择了参与两个问题而非一个问题，一些异常情况难免会出现。

局限主要涉及模板参数和一些复杂函数。我还没有尝试函数指针作为函数参数，因此这很可能也会出问题。如果您认为这个错误太严重或者影响了您的代码流程，您可以在问题跟踪器中创建一个问题。您也可以提交补丁来自行修复功能。 :)

待办事项

  • 允许配置选项。以下是一些示例
    • 在片段中插入 @author 标签
    • 缩进选择
  • 支持其他类型的注释，如 `///` 和 `!!`
  • 变量文档