ToolTip-Helper

作者：Idan Avitan

鸣谢：Dooble

此插件在Sublime Text 3下显示光标下或悬停在函数名上的工具提示。适用于所有语言（包括自定义语言）。

功能

• 包含HTML、CSS和Sublime API（Python）的文档。
• 在函数定义之上编写自己的文档。
• 为相同语言范围定义多个文档文件。
• 工具提示窗口的颜色与Sublime中的当前主题相匹配。
• 确定工具提示窗口中属性的顺序。
• 控制设置，如：窗口大小、超时、调试模式。
• 转到文档定义。
• 转到文档网站。
• 从设置文件中控制CSS。

内置文档

动态文档

它是如何工作的？

创建文档有两种方式：内置文件 & 动态文档。

对于内置文件

• 确保在包的ToolTipHelper\db文件夹中。
• 在此文件夹中创建 languageName.sublime-tooltip（JSON文件）。
• 在此文件上设置其范围名称

一旦创建了 languageName.sublime-tooltip 并声明它，工具提示就会知道搜索文档并从其中检索数据以显示弹出窗口。此文件包含您希望在工具提示窗口中显示的每个属性名称。例如，函数的属性名称可以是：方法名称、参数、说明和返回值。

注意：JSON文件需要从可能引起错误的字符中干净。您可以使用此站点检查您的文件是否有效。

以下是Sublime API文档的示例

关于文件格式的一些重要事项

对于动态文档

• 选择一个函数。
• 在函数上方直接编写doc标记。
• 在标签之间添加一些属性，当每个键和值由冒号分开时。

注意：如果在函数名中存在多个文档，将快速打开包含结果列表的面板。每个结果将显示行号和文件名，当选择结果时，将打开提示窗。您还可以再次运行提示窗，您最后一次选择的结果将被高亮显示。

设置

在继续之前，请确保您已安装Package Control（如果您不想安装Package Control，可以仍然从GitHub下载项目的ZIP文件，但不推荐）。

要将工具提示助手包添加到Sublime，您首先需要将一个新的存储库添加到您的包管理器中。要在Sublime中这样做，打开命令面板。要打开画布，请按ctrl+shift+p（Win, Linux）或cmd+shift+p（OS X）。在那里，您应该搜索“添加存储库”

之后，您需要粘贴此链接：https://github.com/doobleweb/ToolTip-Helper.git并按回车。

一旦添加了存储库，您需要安装软件包。为此，再次打开画布（ctrl+shift+p），搜索“安装包”并按回车。

注意：建议在安装完成后重新打开Sublime Text。

请确保在“packages”（首选项>首选项>浏览包）中有一个名为“ToolTip-Helper\db”的文件夹。此文件夹必须包含languageName.sublime-tooltip文件。还可以查看默认设置文件ToolTipHelper.sublime-settings。您可以在ToolTip-Helper文件夹中找到此文件，或转到菜单首选项>工具提示助手>设置-默认。

正如您所看到的那样，此文件包含每个语言的文档文件数组。每个项目都必须包含作用域和文件名，就像在图片中一样。

• 作用域 - 作用域名必须有效，否则将无法使用。如果您不知道如何编写有效的作用域，可以查看Git项目中的scopes.txt文件或在Sublime Text中按ctrl+alt+shift+p（您将在状态栏中看到作用域名）。
• 文件名 - 包含languageName.sublime-tooltip文件名。此文件数组是工具提示了解是否在“ToolTipHelper\db”文件夹中搜索这些文件的方式。
• 链接 - 您可以写入指向另一个信息文档网站的链接（链接是可选的）。

注意：您可以在设置文件或在JSON文件中将链接放在两个位置，作为“链接”属性。如果有的话，工具提示将选择最“内部”的链接。

要覆盖默认设置，可以打开packages\user\ToolTipHelper.sublime-settings中的文件或转到菜单首选项>工具提示助手>设置-用户。

通过用户界面输入数据

如果您在db文件夹中创建了languageName.sublime-tooltip并想声明快捷键，请使用此方式。

要运行此命令，您有3种方式：- 打开面板，按ctrl+shift+p并选择“工具提示助手将数据插入设置”。- 首选项>工具提示助手>输入数据。- Ctrl+7。

如果您不想要提供链接，只需按回车键。

目前，该插件与F1或命令面板一起工作。如果您想更改它，请转到首选项>首选项绑定-用户。

未来目标

• 在内置文件中转到文档。