DocBlockr 技术文档

1. 安装指南

使用 Package Control 安装

1. 打开 Sublime Text，进入 Preferences -> Package Control。
2. 选择 Package Control: Install Package。
3. 在搜索框中输入 DocBlockr，然后选择该包进行安装。

2. 项目的使用说明

功能概述

DocBlockr 是一个用于 Sublime Text 2 和 3 的插件，旨在简化文档编写过程。它支持多种编程语言，包括 JavaScript（包括 ES6）、PHP、ActionScript、Haxe、CoffeeScript、TypeScript、Java、Apex、Groovy、Objective C、C、C++ 和 Rust。

基本用法

文档块补全

在 /** 后按下 Enter 或 Tab 键，会自动生成一个新的行并关闭注释块。

函数文档

如果下一行包含函数定义，DocBlockr 会自动解析函数名和参数，并生成相应的文档。

变量文档

如果下一行包含变量声明，DocBlockr 会尝试确定变量的数据类型，并将其插入到注释中。

3. 项目API使用文档

配置选项

• jsdocs_indentation_spaces：设置缩进空格数。
• jsdocs_align_tags：设置标签对齐方式，可选值为 'no'、'shallow' 和 'deep'。
• jsdocs_extra_tags：添加额外的标签。

快捷键

• Tab：在文档字段间移动。
• Shift+Tab：在文档字段间反向移动。
• Alt+Shift+Tab 或 Alt+W：重新解析文档块。
• Alt+Q：重新格式化段落。

4. 项目安装方式

通过 Sublime Text 的 Package Control 进行安装，具体步骤如下：

1. 打开 Sublime Text，进入 Preferences -> Package Control。
2. 选择 Package Control: Install Package。
3. 在搜索框中输入 DocBlockr，然后选择该包进行安装。