sublime-jsdocs 安装与使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00633/article/details/141075838

sublime-jsdocs 安装与使用教程

sublime-jsdocsSimplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++项目地址:https://gitcode.com/gh_mirrors/su/sublime-jsdocs

1. 项目目录结构及介绍

.
├── test                      # 测试目录
│   └── tests                 # 包含测试用例
└── sublime-jsdocs           # 主要源代码目录
    ├── sublime-keymap        # 键盘映射文件
    ├── sublime-settings      # 用户设置文件
    ├── sublime-macro         # 宏定义文件
    ├── Default (OSX)         # macOS 默认键盘映射
    ├── Default (Windows)     # Windows 默认键盘映射
    ├── Default               # 通用默认设置
    ├── HISTORY.md            # 更新历史
    ├── LICENSE                # 许可证文件
    ├── README.md             # 项目README
    ├── actionscript          # 动作脚本相关的补全文件
    ├── coffee                 # CoffeeScript 相关的补全文件
    ├── java                   # Java 相关的补全文件
    ├── js                     # JavaScript 相关的补全文件
    ├── jsdocs-auto-complete  # 自动补全宏定义
    ├── jsdocs.py              # Python 实现的核心功能
    ├── php                    # PHP 相关的补全文件
    └── test_runner            # 测试运行器相关文件

sublime-jsdocs项目的主要目录包含了各种平台和语言的补全文件、键盘映射以及设置文件，这些文件共同协作来提供JSDoc注释的自动化功能。

2. 项目的启动文件介绍

该项目的核心功能位于sublime-jsdocs/jsdocs.py文件中，这是一个Python脚本，负责处理注释的生成逻辑。当用户触发相关的快捷键或者命令时，这个脚本会被调用来解析当前光标位置的上下文信息，并生成对应的JSDoc注释模板。

在Sublime Text中，并无单独的“启动文件”，而是通过插件系统加载并执行该Python脚本。

3. 项目的配置文件介绍

sublime-settings 文件

sublime-jsdocs/sublime-settings文件包含了插件的默认设置。用户可以参考这个文件中的选项来个性化自己的JSDoc注释风格。在Sublime Text中，用户还可以在Preferences > Package Settings > sublime-jsdocs > Settings - User找到并编辑自己的用户设置，覆盖默认配置。

部分可配置选项包括：

template_function: 函数注释模板
template_class: 类注释模板
auto_complete_trigger: 触发自动补全的字符序列
disable_when_comments_exist: 是否在已有注释的情况下禁用插件

sublime-keymap 文件

sublime-jsdocs/Default (OSX)和sublime-jsdocs/Default (Windows)目录下的文件定义了在不同操作系统上的键盘快捷方式。例如，你可以在这里看到如何绑定/**到插入JSDoc注释的操作。用户可以通过Preferences > Key Bindings - User自定义自己的快捷键。