# @dev-build-deploy/comment-it 中文文档

规范地址：https://npmcn.com/package/%40dev-build-deploy/comment-it/

版本：2\.2\.1
npm 元数据更新时间：2026-11-01T12:16:26.792Z
中文译文更新时间：2026-11-12T01:47:33.257Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dev-build-deploy/comment-it
原文对照：https://npmcn.com/package/%40dev-build-deploy/comment-it/?lang=original
项目主页：https://github.com/dev-build-deploy/comment-it#readme
源码仓库：https://github.com/dev-build-deploy/comment-it

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：36 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2023-06-30T21:12:22.171Z
- 最新版本发布：2026-11-01T12:16:26.615Z
- 近 30 天下载量：16386（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 1 个）

## 中文简介

源文件注释管理库

## 安装

```sh
npm install @dev-build-deploy/comment-it
```

也可以使用：`pnpm add @dev-build-deploy/comment-it`、`yarn add @dev-build-deploy/comment-it`、`bun add @dev-build-deploy/comment-it`

## README

# 注释It - 注释提取库

从您的文件中提取注释块 .

## 特征

-   简单使用
-   提取单行和多行评论块
-   支持范围 [语言](https://npmcn.com/package/%40dev-build-deploy/comment-it/src/languages/languages.json) 覆盖 GitHub (+多) 中使用的前25种语言
-   将字符串和注释分开:字符串文字中的注释符号不是注释,引用 在注释中( 如在 `// the file's header`(没有启动字符串)
-   静曰: `isSupported()` 返回时 `false` 用于一个未知语言的文件,而不记录任何信息

## 基本用途

```typescript
import { extractComments } from "@dev-build-deploy/comment-it";

const file = "README.md";

// Check if the file is supported by CommentIt
if (isSupported(file)) {
  const config = {
    /** Only consider comments in the first ..n lines */
    maxLines: 20,
    /** Group sequential singleline comments into a comment block */
    groupSingleline: true,
  };

  // Retrieve each comment block using an iterator
  for await (const comment of extractComments(file), /* OPTIONAL */ config) {
    console.log(JSON.stringify(comment, null, 2));
  }
}
```

上述例子将产生:

```json
{
  "type": "multiline",
  "format": { "start": "<!--", "end": "-->"},
  "contents": [
    {
      "line":   1,
      "column": { "start": 0, "end":  4 },
      "raw":    "<!--",
      "value":  ""
    },
    {
      "line":   2,
      "column": { "start": 0, "end": 64 },
      "raw":    "SPDX-FileCopyrightText: 2023 Kevin de Jong <monkaii@hotmail.com>",
      "value":  "SPDX-FileCopyrightText: 2023 Kevin de Jong <monkaii@hotmail.com>"
    },
    {
      "line":   3,
      "column": { "start": 0, "end": 41 },
      "raw":    "SPDX-License-Identifier: MIT",
      "value":  "SPDX-License-Identifier: MIT"
    },
    {
      "line":  4,
      "column": { "start": 0, "end":  3 },
      "raw": "-->",
      "value": ""
    }
  ]
}

{
  "type": "multiline",
  "format": { "start": "<!--", "end": "-->" },
  "contents": [
    {
      "line": 16,
      "column": { "start": 0, "end": 45 },
      "raw": "<!-- Hee hee, hid a comment block in here -->",
      "value": "Hee hee, hid a comment block in here"
    }
  ]
}
```

## 自定义语言

你可以用这个 `addLanguage()` 函数在验证集中添加新语言:

```typescript
import { addLanguage } from "@dev-build-deploy/comment-it";

addLanguage({
  name: "Pingu Language",
  filenames: [".pingu"],
  extensions: [".noot"],
  singleline: "{%NOOTNOOT%}",
});
```

同样的函数也可以被用来覆盖一个(默认)配置. 譬如说, 以下代码片段取代注释前缀 `;` 改为 `#` 用于文件 页:1`.ini` 文件扩展名 :

```typescript
import { addLanguage } from "@dev-build-deploy/comment-it";

addLanguage({
  name: "Custom ini",
  extensions: [".ini"],
  singleline: "#",
});
```

## 捐款

如果您对如何改进评论有建议, 或者想要报告错误, 请打开一个问题 ! 我们很乐意所有的贡献.

更多,请检查 [贡献指南](https://npmcn.com/package/%40dev-build-deploy/comment-it/CONTRIBUTING.md)。 。 。 .

## 许可证

-   [麻省理工学院](https://npmcn.com/package/%40dev-build-deploy/comment-it/LICENSES/MIT.txt) 2023 凯文·德·钟 <monkaii@hotmail.com>

## 常见问题

### @dev-build-deploy/comment-it 是什么？

源文件注释管理库

### 如何安装 @dev-build-deploy/comment-it？

在项目目录运行 npm install @dev-build-deploy/comment-it，或使用 pnpm add / yarn add / bun add。

### @dev-build-deploy/comment-it 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dev-build-deploy/comment-it 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dev-build-deploy/comment-it 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @dev-build-deploy/comment-it 可以商用吗？

@dev-build-deploy/comment-it 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dev-build-deploy/comment-it 的下载量有多少？

根据 npm 官方下载统计，@dev-build-deploy/comment-it 在 2026/10/12 – 2026/11/10 这 30 天内被下载 16,386 次，日均约 546 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dev-build-deploy/comment-it 还在维护吗？

最新版本 2\.2\.1 发布于 2026/11/01（10 天前）；至今共发布 25 个版本，其中过去 12 个月发布了 1 个；首次发布于 2023/07/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。