# @guardian/eslint-plugin-tsdoc-required 中文文档

规范地址：https://npmcn.com/package/%40guardian/eslint-plugin-tsdoc-required/

版本：0\.1\.3
npm 元数据更新时间：2025-10-28T11:46:59.735Z
中文译文更新时间：2026-11-17T06:37:00.942Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40guardian/eslint-plugin-tsdoc-required
原文对照：https://npmcn.com/package/%40guardian/eslint-plugin-tsdoc-required/?lang=original

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

- 包体积（解压后）：4.3 MB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2023-02-24T18:02:29.994Z
- 最新版本发布：2023-03-02T12:43:30.165Z
- 近 30 天下载量：5566（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

要求输出成员有TSDoc的评论.

## 安装

```sh
npm install @guardian/eslint-plugin-tsdoc-required
```

也可以使用：`pnpm add @guardian/eslint-plugin-tsdoc-required`、`yarn add @guardian/eslint-plugin-tsdoc-required`、`bun add @guardian/eslint-plugin-tsdoc-required`

## README

# @ guardian/slint-tsdoc- required( 需要保护) @ info

一项ESLint规则要求出口成员 [信息技术事务司](https://tsdoc.org/) 评论.

## 常见问题

### @guardian/eslint-plugin-tsdoc-required 是什么？

要求输出成员有TSDoc的评论\.

### 如何安装 @guardian/eslint-plugin-tsdoc-required？

在项目目录运行 npm install @guardian/eslint-plugin-tsdoc-required，或使用 pnpm add / yarn add / bun add。

### @guardian/eslint-plugin-tsdoc-required 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/guardian\_\_eslint-plugin-tsdoc-required 是否存在。

### @guardian/eslint-plugin-tsdoc-required 支持 ESM 还是 CommonJS？

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

### @guardian/eslint-plugin-tsdoc-required 可以商用吗？

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

### @guardian/eslint-plugin-tsdoc-required 的下载量有多少？

根据 npm 官方下载统计，@guardian/eslint-plugin-tsdoc-required 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,566 次，日均约 186 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @guardian/eslint-plugin-tsdoc-required 还在维护吗？

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

