# @borgar/jsdoc-tsmd 中文文档

规范地址：https://npmcn.com/package/%40borgar/jsdoc-tsmd/

版本：0\.2\.2
npm 元数据更新时间：2024-03-28T18:03:29.822Z
中文译文更新时间：2026-11-08T11:41:15.541Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40borgar/jsdoc-tsmd
原文对照：https://npmcn.com/package/%40borgar/jsdoc-tsmd/?lang=original

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

- 包体积（解压后）：90.4 kB，173 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：jsdoc ~4\.0\.2
- 首次发布：2023-08-02T16:35:24.220Z
- 最新版本发布：2024-03-28T18:03:29.630Z
- 近 30 天下载量：3220（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

打印 Markdown 和 TypeScript 声明文件的 A (有限) JSDoc 模板

## 安装

```sh
npm install @borgar/jsdoc-tsmd
```

也可以使用：`pnpm add @borgar/jsdoc-tsmd`、`yarn add @borgar/jsdoc-tsmd`、`bun add @borgar/jsdoc-tsmd`

## README

# 日记

A 类 [联合来文文件](https://jsdoc.app/) 用于小项目的模板,可以发送Markdown Docs或TypeScript类型.

不建议使用,因为它只执行作者使用的JSDoc的几个部分。 随着TS工具的不断完善,项目可能会消亡.

## 设置

像其他JSDoc模板一样设置这个. 安装软件包开始 :

```sh
npm i -D @borgar/jsdoc-tsmd
```

然后添加一个配置文件, 它可能看起来是这样的 :

```json
{
  "source": {
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "((^|\\/|\\\\)_|spec\\.js$)"
  },
  "opts": {
    "template": "node_modules/@borgar/jsdoc-tsmd",
    "destination": "console",
  }
}
```

运行 `jsdoc -c myconfig.json src` ,然后释放一些 Markdown 文档(因为来源中有有效的 jsdoc 注释)。 参见以下关于如何生成 TypeScript 类型声明的选项.

#### 选项 :

一般来说,参考JSDoc的 [关于如何配置的文档](https://jsdoc.app/about-configuring-jsdoc.html) 但这些选项具有特殊意义:

-   `destination` - 何处保存已发布的文本,使用 `"console"` 将记录输出到控制台.
-   `output` - 把它设定为 `"typescript"` 以发出 TypeScript 类型声明,而不是 Markdown docs .
-   `validate` - 制作类型声明时,输出会通过 TypeScript 运行以验证它,如果您喜欢生活在边缘,您可以设定为 `false` 跳过这一步.

## 许可证

[麻省理工学院](https://npmcn.com/package/%40borgar/jsdoc-tsmd/LICENSE)

## 常见问题

### @borgar/jsdoc-tsmd 是什么？

打印 Markdown 和 TypeScript 声明文件的 A \(有限\) JSDoc 模板

### 如何安装 @borgar/jsdoc-tsmd？

在项目目录运行 npm install @borgar/jsdoc-tsmd，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：jsdoc（~4\.0\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @borgar/jsdoc-tsmd 支持 TypeScript 吗？

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

### @borgar/jsdoc-tsmd 支持 ESM 还是 CommonJS？

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

### @borgar/jsdoc-tsmd 可以商用吗？

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

### @borgar/jsdoc-tsmd 的下载量有多少？

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

### @borgar/jsdoc-tsmd 还在维护吗？

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