使用 Homebrew, Nix 安装 jsdoc3

项目链接

• 主页

命令和别名

• jsdoc

项目历史

The JSDoc project traces its modern implementation to Michael Mathews and contributors; the JSDoc repository states copyright beginning in 2011, and its change history starts with version 3.0.0. The documentation describes JSDoc 3 as an API documentation generator for JavaScript, similar to Javadoc and phpDocumentor, with comments stored beside the source code.

JSDoc 3 became the package-manager-facing generation: installable through npm and Homebrew, runnable as `jsdoc`, and configurable with JSON or JavaScript configuration files. Later 3.x releases tracked JavaScript syntax changes, including ES2015 classes, modules, async functions, generators, and Babel-era parsing support. JSDoc 4.0.0 in November 2022 adopted semantic versioning and removed the `taffydb` dependency, marking a cleanup of the older template-data model.

采用历史

JSDoc was adopted both as a documentation generator and as a comment syntax understood by editors, build tools, templates, and downstream processors. The project README lists community templates, Grunt and Gulp integrations, a GitHub Action, and tools such as `jsdoc-to-markdown`, which shows the package's role as an ecosystem hub rather than a single output format.

The package remained useful even as TypeScript grew: JSDoc comments became a bridge for JavaScript projects that wanted better generated docs, editor hints, or type-aware tooling without rewriting code as TypeScript.

使用方式

Typical usage is to install `jsdoc`, run it against JavaScript source files, and optionally supply a configuration file such as `conf.json` or `conf.js` to control source paths, plugins, templates, and output. By default the tool writes generated documentation into an `out` directory unless a destination option is provided.

为什么软件包爱好者会关心

For package-maintainer culture, `jsdoc3` is a classic example of a formula name encoding a major upstream generation. It also represents the era when JavaScript documentation tooling moved from browser/Rhino-adjacent tooling into npm-driven command-line workflows, while still producing plain static documentation that Unix package managers could ship.

时间线

• 2011: JSDoc copyright and the GitHub-hosted JSDoc 3 generation begin according to the upstream README.
• 2012: JSDoc 3.0.0 appears as the first version covered by the upstream change history.
• 2017: JSDoc 3.5.0 switches to the Babylon parser and expands support for newer JavaScript syntax.
• 2019: JSDoc 3.6.0 adds Node.js 12 compatibility and recognizes documented Closure Compiler tags.
• 2022: JSDoc 4.0.0 adopts semantic versioning and removes the `taffydb` package.

Related projects

• JSDoc's syntax was inspired by JavaDoc-style documentation. Its ecosystem includes templates such as DocStrap, minami, docdash, and better-docs, build integrations for Grunt and Gulp, and converters such as `jsdoc-to-markdown`.

来源

• https://github.com/jsdoc/jsdoc
• https://github.com/jsdoc/jsdoc/blob/main/CHANGES.md
• https://jsdoc.app/
• https://jsdoc.app/about-configuring-jsdoc
• https://jsdoc.app/about-getting-started