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

注释表

由 kizza 全部

组织并快速跳转到你的注释中的标题（类似于“跳转到符号”）和可选地输出一个实时目录表。

标签 评论，文档，工具

详细信息

安装

  • 总数 2K
  • Win 1K
  • Mac 693
  • Linux 295
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 0 1 0 0 1 1 0 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 1 0 0 0 0 0 0 0 0
Mac 1 1 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 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

说明文件

源代码
raw.​githubusercontent.​com

注释表

这是一个Sublime Text 2 & 3插件，允许你组织并快速跳转到注释中的标题（例如“跳转到符号”），同时还可以在文档内部可选地输出一个实时目录表。

在你的注释中使用标题来组织代码，然后运行插件以打开快速跳转面板，轻松地在文档各部分之间导航。它不仅可以帮助你快速使用自定义标题进行代码导航，还能帮助你保持整洁并意识到文档的整体结构。

如何安装

通过Package Control

打开您的命令面板 -> Package Control: Install Package -> 注释表

手动

转到您的包文件夹（首选项 -> 浏览包）

# clone this repo
git clone https://github.com/kizza/Table-of-comments 'Table of comments'

或者下载最新的版本并在名为《注释表》的文件夹中解压缩

如何使用

只需使用以下格式在注释中使用标题来组织代码。默认标题由“>”表示，但每个标题前缀都可以通过设置进行自定义。

/*
* > Heading 1
*/
...
/*
* >> Heading 2
*/
...
/*
* >>> Heading 3
*/

在标题间跳转

运行插件的简便方法是通过快捷键，这样在键入时可以快速打开快速跳转菜单。

  1. 在偏好设置中添加按键绑定（推荐） 从主菜单打开“首选项 -> 键绑定 - 用户”，然后粘贴

    { "keys": ["f1"], "command": "table_of_comments" }

    (此示例通过按F1运行插件)

  2. 您还可以通过命令面板（Crtl+ Shift + P）运行插件。只需找到并执行“注释表：显示”

然后，就像您能够快速跳转到函数和选择器一样，您现在可以在文档中的文档和注释标题之间跳转。

在注释中上移和下移

您还可以从您的当前位置移动到下一个/上一个注释。以下是您可以从主菜单的“首选项 -> 键绑定 - 用户”设置的一些键绑定示例。

{ "keys": ["alt+up"],   "command": "table_of_comments", "args":{ "move":"up" } }
{ "keys": ["alt+down"], "command": "table_of_comments", "args":{ "move":"down" } }

您可以自由设置您喜欢的键盘快捷键。（此行为受Sublime Move By Symbols 插件启发）

折叠和展开部分

当前的注释部分（或所有部分）可以使用命令或键盘快捷键进行折叠和展开。以下是您可以从主菜单的“首选项 -> 键绑定 - 用户”设置的一些键绑定示例。

折叠当前部分：“{ 'keys': ['alt+['], 'command': 'table_of_comments', 'args': { 'fold': true } } {'keys': ['alt+]'], 'command': 'table_of_comments', 'args': { 'unfold': 'true' } }”

Fold and unfold all sections

{ 'keys': ['alt+shift+['], 'command': 'table_of_comments', 'args': { 'fold': 'all' } } {'keys': ['alt+shift+]'], 'command': 'table_of_comments', 'args': { 'unfold': '"all"' } }

### Outputting a table of contents (optional)

You can optionally output a maintained list of the headings within your document
by placing "TOC" inside a separate comment anywhere within the document.

For example placing...

```/* TOC */```

...anywhere in your document will automatically update it to reflect the headings 
within your comments each time you run the plugin.

/* * TOC * * 标题 1 * - 标题 2 * – 标题 3 * — 标题 4 */

You can change the title for your table of contents within the plugin settings.  
For example, you can change "TOC" to be "Within this document", then simply place 
that text within a comment in your document to have the table of content maintained 
with that heading.

### Customising the plugin

You can tweak the plugin settings for parsing headings (ie. which characters 
designate each level of headings) as well as for formatting the table of contents output.

To view the existing plugin settings run the command 
"Table of comments: Settings - Default" from the command palette (Ctrl + Shift + P).
Then run "Table of comments: Settings - User" and paste in any of the settings 
you wish to change.

Ultimately the above creates a "tableofcomments.sublime-settings" file in
your "Packages/User" directory.

#### Changing the heading characters

For example you can use colons to designate level headings...

/* * : 标题 1 * * :: 标题 2 * * ::: 标题 3 */

By using the setting...

"level_char": ":",

#### Tweaking the table of comments title

Rather than "TOC" designating the comment to be updated with your table of contents 
you could enter the setting...

“toc_title": "在此文档内”

Which means you can use the comment below to manage your table of contents

/* 在此文档内 */

#### Only showing first level headings within the table of comments

If you've dilegently organised lots of first, second and third headings within your
document for the purposes of quick-jumping around, it may be too much to display 
them all within the table of comments.

You could of course not include the /* TOC */ comment in your document, or use the 
setting below to only show first level headings.

“toc_level": “1”

#### Generate TOC on save

To generate the TOC you need to enable the following configuration:

“toc_generate_on_save": true