ts-comments.nvim 项目使用教程

目录结构及介绍

ts-comments.nvim/
├── LICENSE
├── README.md
├── lua/
│   └── ts_comments/
│       ├── init.lua
│       └── config.lua
├── plugin/
│   └── ts_comments.lua

• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目说明文档，包含项目的基本介绍、安装和使用方法。
• lua/: 包含项目的核心逻辑文件。
  • init.lua: 项目的入口文件，负责初始化插件。
  • config.lua: 配置文件，定义了不同语言的注释字符串。
• plugin/: 包含插件的加载文件。
  • ts_comments.lua: 插件的加载脚本，负责加载插件并应用配置。

项目的启动文件介绍

项目的启动文件是 lua/ts_comments/init.lua。这个文件负责初始化插件，并加载必要的配置。以下是该文件的主要内容：

-- 初始化插件
require('ts_comments').setup()

该文件通过调用 setup 函数来初始化插件，并应用默认配置或用户自定义配置。

项目的配置文件介绍

项目的配置文件是 lua/ts_comments/config.lua。这个文件定义了不同语言的注释字符串，并提供了默认配置。以下是该文件的部分内容：

local config = {
  lang = {
    astro = "< -- %s -->",
    axaml = "< -- %s -->",
    blueprint = "// %s",
    c = "// %s",
    c_sharp = "// %s",
    clojure = { " %s", " %s" },
    cpp = "// %s",
    cs_project = "< -- %s -->",
    cue = "// %s",
    fsharp = "// %s",
    fsharp_project = "< -- %s -->",
    gleam = "// %s",
    glimmer = "[[ %s ]]",
    graphql = "# %s",
    handlebars = "[[ %s ]]",
    hcl = "# %s",
    html = "< -- %s -->",
    hyprlang = "# %s",
    ini = "; %s",
    -- 其他语言配置...
  }
}

return config

该文件通过定义 lang 表来配置不同语言的注释字符串。用户可以根据需要修改或扩展这些配置。