# @geosolutions/jsdoc 中文文档

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

版本：3\.4\.4
npm 元数据更新时间：2022-04-05T13:57:24.429Z
中文译文更新时间：2026-11-16T04:56:43.082Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.5 MB，125 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=0\.10
- 运行依赖：13 个
- 首次发布：2019-12-03T10:02:23.827Z
- 最新版本发布：2019-12-03T10:02:24.286Z
- 近 30 天下载量：7958（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

JavaScript 的 API 文档生成器 .

## 安装

```sh
npm install @geosolutions/jsdoc
```

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

## README

# 叉线信息

这回贷被扣了,因为我们需要加注 [这个](https://github.com/geosolutions-it/jsdoc/tree/a6788273cbe97d680393a75c35c5dc69ae9a1bfe) 修复.  
我们将出版 **释放** npm 地产登记册上的分支

此 lib 被使用 [这里](https://github.com/geosolutions-it/MapStore2/blob/dbab92bb6f09225f1e6a3f4b46c9670227e342fc/package.json#L37)

# 联署材料文件3

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

JavaScript 的 API 文档生成器 .

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

## 安装和使用

JSDoc支持"节点"(Node.js 0.10)及后期. 您可以在您的项目中安装 JSDoc `node_modules` 文件夹,也可以在全球安装.

安装国家预防机制最新版本:

```
npm install jsdoc
```

要安装最新的开发版本 :

```
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) (单位:千美元)[实例](http://davidshimjs.github.io/jaguarjs/doc)(中文(简体) )
-   [标签](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 Grunt 插件](https://github.com/krampstudio/grunt-jsdoc)
-   [JSDoc 蚂蚁任务](https://github.com/jannon/jsdoc3-ant-task)

## 更多信息

-   文件备查 [使用 JSDoc](http://usejsdoc.org/)。 。 。 .
-   协助文件 [jsdoc3/jsdoc3.github.com (中文(简体) )](https://github.com/jsdoc3/jsdoc3.github.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` 详情请参见此分配表.

## 常见问题

### @geosolutions/jsdoc 是什么？

JavaScript 的 API 文档生成器 \.

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

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

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

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

### @geosolutions/jsdoc 支持 ESM 还是 CommonJS？

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

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

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

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

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

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

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

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

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

