Better Comments 项目教程

Better Comments 项目教程

better-comments项目地址:https://gitcode.com/gh_mirrors/be/better-comments

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

Better Comments 是一个用于 Visual Studio Code 的扩展，旨在通过不同的注释样式来提高代码的可读性。以下是该项目的目录结构及其介绍：

better-comments/
├── .github/
│   └── workflows/
│       └── ci.yml
├── images/
│   └── icon.png
├── src/
│   ├── extension.ts
│   ├── test/
│   │   └── extension.test.ts
│   └── utils/
│       └── commentParser.ts
├── package.json
├── README.md
└── CHANGELOG.md

• .github/workflows/ci.yml: GitHub Actions 的工作流配置文件，用于持续集成。
• images/icon.png: 扩展的图标文件。
• src/: 源代码目录。
  • extension.ts: 扩展的主入口文件。
  • test/: 测试目录，包含扩展的测试代码。
  • utils/: 工具函数目录，包含注释解析器等工具函数。
• package.json: 项目的元数据文件，包含依赖、脚本等信息。
• README.md: 项目的说明文档。
• CHANGELOG.md: 项目的更新日志。

2. 项目的启动文件介绍

Better Comments 的启动文件是 src/extension.ts。这个文件是扩展的主入口点，负责初始化扩展并注册各种命令和事件监听器。以下是 src/extension.ts 的主要内容：

import * as vscode from 'vscode';
import { CommentParser } from './utils/commentParser';

export function activate(context: vscode.ExtensionContext) {
    // 初始化注释解析器
    const commentParser = new CommentParser();

    // 注册命令和事件监听器
    context.subscriptions.push(
        vscode.workspace.onDidChangeTextDocument((event) => {
            // 处理文本更改事件
        })
    );
}

export function deactivate() {
    // 扩展停用时的清理工作
}

• activate 函数: 当扩展被激活时调用，初始化注释解析器并注册事件监听器。
• deactivate 函数: 当扩展被停用时调用，进行清理工作。

3. 项目的配置文件介绍

Better Comments 的配置文件是 package.json。这个文件包含了扩展的所有元数据和配置信息。以下是 package.json 的主要内容：

{
  "name": "better-comments",
  "displayName": "Better Comments",
  "description": "Improve your code commenting by annotating with alert, informational, TODOs and more!",
  "version": "3.0.0",
  "publisher": "aaron-bond",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onLanguage:plaintext",
    "onLanguage:javascript",
    "onLanguage:typescript",
    "onLanguage:python",
    "onLanguage:csharp",
    "onLanguage:cpp",
    "onLanguage:java",
    "onLanguage:php",
    "onLanguage:ruby",
    "onLanguage:go",
    "onLanguage:rust",
    "onLanguage:swift",
    "onLanguage:kotlin",
    "onLanguage:scala",
    "onLanguage:haskell",
    "onLanguage:elm",
    "onLanguage:clojure",
    "onLanguage:erlang",
    "onLanguage:elixir",
    "onLanguage:fsharp",
    "onLanguage:dart",
    "onLanguage:julia",
    "onLanguage:r",
    "onLanguage:perl",
    "onLanguage:lua",
    "onLanguage:groovy",
    "onLanguage:objective-c",
    "onLanguage:objective-cpp",
    "onLanguage:powershell",
    "onLanguage:shellscript",
    "onLanguage:batchfile",
    "onLanguage:dockerfile",
    "onLanguage:makefile",
    "onLanguage:properties",
    "onLanguage:ini",
    "onLanguage

better-comments项目地址:https://gitcode.com/gh_mirrors/be/better-comments