@geosolutions/jsdoc

中文文档
3.4.4发布于 2019/12/03Apache-2.0CommonJS近 30 天下载 7958

JavaScript 的 API 文档生成器 .

中文使用文档
文档目录6 节
  1. 安装和使用
  2. 模板和构建工具
  3. 模板
  4. 构建工具
  5. 更多信息
  6. 许可证

叉线信息

这回贷被扣了,因为我们需要加注 这个 修复.
我们将出版 释放 npm 地产登记册上的分支

此 lib 被使用 这里

联署材料文件3

Build Status

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社区创建了许多模板和其他工具来帮助你 生成和自定义文档。 这里只有几个:

模板

构建工具

更多信息

许可证

JSDoc 3是版权 (c) 2011年至今 Michael Mathews 缩略语@gmail.com 编辑 联合来文文件撰稿人。 。 。 .

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

版本与发布记录

@geosolutions/jsdoc 共发布 1 个版本,首次发布于 2019/12/03;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.4.4latest2019/12/036 年前

关于 @geosolutions/jsdoc 的常见问题

@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 和提交记录判断。