VSCode Document This 插件使用教程

VSCode Document This 插件使用教程

vscode-docthisJSDoc generator extension for Visual Studio Code.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-docthis

1. 项目的目录结构及介绍

VSCode Document This 插件的 GitHub 仓库地址为：https://github.com/joelday/vscode-docthis。以下是该项目的目录结构及主要文件介绍：

vscode-docthis/
├── .github/
│   └── ISSUE_TEMPLATE/
├── .vscode/
│   ├── extensions.json
│   ├── launch.json
│   └── settings.json
├── src/
│   ├── commands/
│   │   ├── documentThis.ts
│   │   └── traceTypeScriptSyntaxNode.ts
│   ├── extension.ts
│   ├── language/
│   │   ├── commentParser.ts
│   │   ├── commentWriter.ts
│   │   ├── jsDocTag.ts
│   │   └── tagProvider.ts
│   ├── test/
│   │   ├── extension.test.ts
│   │   └── index.ts
│   └── util/
│       ├── configuration.ts
│       ├── logger.ts
│       └── stringUtils.ts
├── .gitignore
├── .npmrc
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── tslint.json

主要目录和文件介绍：

• .github/: 包含 GitHub 相关配置文件，如 Issue 模板。
• .vscode/: 包含 VSCode 开发环境配置文件，如调试配置、扩展推荐等。
• src/: 包含插件的主要源代码。
  • commands/: 包含插件的命令实现。
  • language/: 包含与语言相关的处理逻辑，如注释解析和生成。
  • test/: 包含插件的测试代码。
  • util/: 包含一些工具函数和配置处理。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。
• tslint.json: TypeScript 代码风格检查配置。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件是插件的入口点，负责注册命令和初始化插件。

import * as vscode from 'vscode';
import { documentThis } from './commands/documentThis';
import { traceTypeScriptSyntaxNode } from './commands/traceTypeScriptSyntaxNode';

export function activate(context: vscode.ExtensionContext) {
    context.subscriptions.push(
        vscode.commands.registerCommand('docthis.documentThis', documentThis),
        vscode.commands.registerCommand('docthis.traceTypeScriptSyntaxNode', traceTypeScriptSyntaxNode)
    );
}

export function deactivate() {}

主要功能：

• activate(): 插件激活时调用，注册插件命令。
• deactivate(): 插件停用时调用，目前为空。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json。这个文件包含了插件的元数据、依赖、命令和配置项。

{
  "name": "docthis",
  "displayName": "Document This",
  "description": "Automatically generates detailed JSDoc comments in TypeScript and JavaScript files.",
  "version": "0.8.0",
  "publisher": "joelday",
  "engines": {
    "vscode": "^1.25.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:docthis.documentThis",
    "onCommand:docthis.traceTypeScriptSyntaxNode"
  ],
  "main": "./out/src/extension",
  "contributes": {
    "commands": [
      {
        "command": "docthis.documentThis",

vscode-docthisJSDoc generator extension for Visual Studio Code.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-docthis