# @daybrush/jsdoc 中文文档

规范地址：https://npmcn.com/package/%40daybrush/jsdoc/

版本：0\.4\.7
npm 元数据更新时间：2023-01-28T07:01:10.483Z
中文译文更新时间：2026-11-11T16:31:07.669Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.7 MB，126 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=4\.2\.0
- 运行依赖：17 个
- 首次发布：2018-08-14T08:07:35.122Z
- 最新版本发布：2023-01-28T07:01:10.364Z
- 近 30 天下载量：16150（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 0 个）

## 中文简介

JavaScript和Typescript的 API 文档生成器.

## 安装

```sh
npm install @daybrush/jsdoc
```

也可以使用：`pnpm add @daybrush/jsdoc`、`yarn add @daybrush/jsdoc`、`bun add @daybrush/jsdoc`

## README

# @ daybrush/jsdoc (日语) [![npm version](https://badge.fury.io/js/%40daybrush%2Fjsdoc.svg)](https://badge.fury.io/js/%40daybrush%2Fjsdoc)

```bash
npm install --save-dev @daybrush/jsdoc
```

## 从0.3.0版本支持打字符

-   [Scene.js Typescript API 文档](https://daybrush.com/scenejs/release/latest/doc/index.html)
-   [@ daybrush/ utils 键入 API 文档](https://daybrush.com/utils/release/latest/doc/index.html)
-   [无限Grid 类型 API 文档](https://naver.github.io/egjs-infinitegrid/release/latest/doc/)

### `name` 财务报告和审定财务报表 `type` 可以在函数和方法中省略

-   日记

```ts
/**
 */
function a(a: Parameter1, b: Parameter2): ReturnType {
}
```

-   结果

## ![](https://npmcn.com/package/%40daybrush/jsdoc/images/function-result.png)

### `extends` 财务报告和审定财务报表 `implements` 可以在课上省略.

-   日记

```ts
/**
*/
export class A extends B implements a {
}
```

-   结果

![](https://npmcn.com/package/%40daybrush/jsdoc/images/class-result.png)

* * *

### 支持类型声明

-   日记

```ts
/**
 * @typedef
 */
export type a<T> = () => T;
```

-   结果

![](https://npmcn.com/package/%40daybrush/jsdoc/images/type-result.png)

* * *

### 支持接口声明

-   日记

```ts
/**
 * @typedef
 */
export interface a {
    a: string;
    b: number;
    c: () => void;
    d(a: string, b: number): void;
    (a: string, b: number): void;
    [key: string]: any;
}
```

-   结果

![](https://npmcn.com/package/%40daybrush/jsdoc/images/interface-result.png)

* * *

### 兹多克.杰森 (添加 ts 扩展以包括 Pattern)

```json
{
    "source": {
        "includePattern": ".+\\.(j|t)s(doc|x)?$",
    },
}
```

# 联署材料文件3

[![Build Status](https://travis-ci.org/jsdoc3/jsdoc.svg?branch=master)](http://travis-ci.org/jsdoc3/jsdoc)

JavaScript 的 API 文档生成器 .

想给JSDoc捐款吗? 请阅读 `CONTRIBUTING.md`。 。 。 .

## 安装和使用

JSDoc支持节点.js 4.2.0及后. 您可以在全球安装 JSDoc 或者在您的项目 `node_modules` 文件夹.

在全球npm上安装最新版本(可能需要) `sudo`· ; [学会如何修复 这个](https://docs.npmjs.com/getting-started/fixing-npm-permissions):

```
npm install -g jsdoc
```

在 npm 本地安装最新版本并保存在您的软件包中 `package.json` 文件 :

```
npm install --save-dev jsdoc
```

**说明**:默认情况下, npm 在版本编号前使用护理操作符添加您的软件包 (例如, `^3.5.2`) (中文(简体) ). 我们建议使用瓷砖操作器(例如, `~3.5.2`, (中文(简体) ), 它将更新限制在最新的补丁级版本。 见 [此堆栈倒流 回复](https://stackoverflow.com/questions/22343224) 关于护身符和瓦片的更多信息 操作员.

在本地安装最新开发版本, 不更新您的项目 `package.json` 文件 :

```
npm install git+https://github.com/jsdoc3/jsdoc.git
```

如果您在本地安装了 JSDoc, JSDoc 命令行工具可在 `./node_modules/.bin`。 。 。 . 生成文件的文档 `yourJavaScriptFile.js`数字 :

```
./node_modules/.bin/jsdoc yourJavaScriptFile.js
```

或者如果你在全球安装了JSDoc, 只需运行 `jsdoc` 命令 :

```
jsdoc yourJavaScriptFile.js
```

默认情况下,生成的文档会被保存在一个命名的目录中 `out`您可以使用 `--destination` (单位:千美元)`-d`)指定另一个目录的选项.

运行 `jsdoc --help` 用于完整命令行选项列表.

## 模板和工具

JSDoc社区创建了许多模板和其他工具,帮助您生成和生成 定制文档。 这里只有几个:

### 模板

-   [贾古阿吉斯多克](https://github.com/davidshimjs/jaguarjs-jsdoc)
-   [标签](https://github.com/docstrap/docstrap) (单位:千美元)[实例](https://docstrap.github.io/docstrap)(中文(简体) )
-   [jsdoc3 模板](https://github.com/DBCDK/jsdoc3Template) (单位:千美元)[实例](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots)(中文(简体) )
-   [min](https://github.com/Nijikokun/minami)
-   [多克达什](https://github.com/clenemt/docdash) (单位:千美元)[实例](http://clenemt.github.io/docdash/)(中文(简体) )
-   [图伊-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template) (单位:千美元)[实例](https://nhnent.github.io/tui.jsdoc-template/latest/)(中文(简体) )

### 构建工具

-   [JSDoc Grunt 插件](https://github.com/krampstudio/grunt-jsdoc)
-   [JSDoc Gulp 插件](https://github.com/mlucool/gulp-jsdoc3)

### 其他工具

-   [jsdoc- to- smarkdown (简体中文)](https://github.com/jsdoc2md/jsdoc-to-markdown)
-   [将 GitBook 与 联合来文文件](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)

## 更多信息

-   文件备查 [使用 JSDoc](http://usejsdoc.org/)。 。 。 .
-   协助文件 [jsdoc3/jsdoc3.github.com (中文(简体) )](https://github.com/jsdoc3/jsdoc3.github.com)。 。 。 .
-   [加入JSDoc的Slack频道](https://jsdoc-slack.appspot.com/)。 。 。 .
-   请求帮助 [联合来文文件 用户邮件列表](http://groups.google.com/group/jsdoc-users)。 。 。 .
-   贴有标签的帖子问题 `jsdoc` 改为 [堆栈 过多](http://stackoverflow.com/questions/tagged/jsdoc)。 。 。 .

## 许可证

JSDoc 3是版权 (c) 2011年至今 Michael Mathews [缩略语@gmail.com](mailto:micmath@gmail.com) 编辑 [捐款人 联合来文文件](https://github.com/jsdoc3/jsdoc/graphs/contributors)。 。 。 .

JSDoc 3是自由软件,根据Apache许可证第2.0版获得许可. 见文件 `LICENSE.md` 详情请参见此分配表.

## 常见问题

### @daybrush/jsdoc 是什么？

JavaScript和Typescript的 API 文档生成器\.

### 如何安装 @daybrush/jsdoc？

在项目目录运行 npm install @daybrush/jsdoc，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 jsdoc，可以用 npx jsdoc 直接运行。

### @daybrush/jsdoc 支持 TypeScript 吗？

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

### @daybrush/jsdoc 需要什么版本的 Node\.js？

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

### @daybrush/jsdoc 可以商用吗？

@daybrush/jsdoc 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @daybrush/jsdoc 的下载量有多少？

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

### @daybrush/jsdoc 还在维护吗？

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