@geosolutions/jsdoc

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

An API documentation generator for JavaScript.

原始使用文档
文档目录6 节
  1. Installation and Usage
  2. Templates and Build Tools
  3. Templates
  4. Build Tools
  5. For More Information
  6. License

Fork info

This repo has been forked because we needed to add this fix.
We are going to publish the release branch on npm GeoSolutions registry

This lib is used here

JSDoc 3

Build Status

An API documentation generator for JavaScript.

Want to contribute to JSDoc? Please read CONTRIBUTING.md.

Installation and Usage

JSDoc supports Node.js 0.10 and later. You can install JSDoc in your project's node_modules folder, or you can install it globally.

To install the latest version available on NPM:

npm install jsdoc

To install the latest development version:

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

If you installed JSDoc locally, the JSDoc command-line tool is available in ./node_modules/.bin. To generate documentation for the file yourJavaScriptFile.js:

./node_modules/.bin/jsdoc yourJavaScriptFile.js

Or if you installed JSDoc globally, simply run the jsdoc command:

jsdoc yourJavaScriptFile.js

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

Run jsdoc --help for a complete list of command-line options.

Templates and Build Tools

The JSDoc community has created numerous templates and other tools to help you generate and customize your documentation. Here are just a few:

Templates

Build Tools

For More Information

License

JSDoc 3 is copyright (c) 2011-present Michael Mathews [email protected] and the contributors to JSDoc.

JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

版本与发布记录

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

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

关于 @geosolutions/jsdoc 的常见问题

@geosolutions/jsdoc 是什么?

An API documentation generator for JavaScript.

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