# 使用 Homebrew, Nix 安装 jsdoc3 查看 jsdoc3 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。 ## 安装 ```sh sudo av install brew:jsdoc3 ``` 其他安装命令: ### macOS - Homebrew (100%): ```sh brew install jsdoc3 ``` 证据: local Homebrew formula metadata ### Linux - Nix (92%): ```sh nix profile install nixpkgs#jsdoc ``` 证据: nixpkgs package indexes: pkgs/by-name/js/jsdoc/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 ## 软件包事实 - **软件包键:** brew:jsdoc3 - **软件包管理器:** Homebrew - **软件包管理器页面:** - **版本:** 4.0.5 - **来源摘要:** API documentation generator for JavaScript - **主页:** - **仓库:** - **上游文档:** - **许可证:** Apache-2.0 - **源码归档:** - **已生成:** 2026-07-08T18:08:21+00:00 ## 可执行文件 - jsdoc (cli) - jsdoc (别名) ## 依赖 - node ## 安装行为 - post-install 钩子: 未定义 - Bottle: 可用 于 all ## 版本和新鲜度 - 页面生成时间: 2026-07-08 - 管理器版本: 4.0.5 - 本地数据: OK - 上游仓库: https://jsdoc.app/ - 信息: No package-manager update timestamp was available. - 信息: Release/tag comparison is only available for GitHub repositories. ## 项目历史与用法 JSDoc is the long-running documentation-generator line for JavaScript source comments: a command-line tool scans `/** ... */` annotations and emits browsable API documentation. The Homebrew `jsdoc3` formula name reflects the JSDoc 3 generation, which moved the tool into the Node.js and npm ecosystem while preserving the older JavaDoc-inspired annotation culture. ### 项目历史 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`. ### 来源 - - - - - ## 安全说明 narrow executable package without higher-risk signals. - **Geiger 风险:** 绿色 / 低 - narrow executable package without higher-risk signals ## Configuration and credential file locations These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval. ## Configuration files - Unix: conf.json, conf.js ## 源数据库详情 - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** jsdoc3 - **Version Scheme:** 0 - **Revision:** 0 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## 其他软件包管理器记录 - Nix - jsdoc: installed executable or alias match | nixpkgs package indexes: pkgs/by-name/js/jsdoc/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 ## 相关链接 - [Terminal utility packages](https://www.automicvault.com/zh-hans/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/zh-hans/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/zh-hans/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [Language runtime packages](https://www.automicvault.com/zh-hans/pkg/language-runtime-packages/) - Matched language runtime, compiler, or interpreter metadata. - [node](https://www.automicvault.com/zh-hans/pkg/brew/node/) - Runtime dependency declared by Homebrew. - [gtk-doc](https://www.automicvault.com/zh-hans/pkg/brew/gtk-doc/) - Shares av.db curated category or tags: api-docs, cli, developer-tools, documentation. - [dashing](https://www.automicvault.com/zh-hans/pkg/brew/dashing/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator. - [docfx](https://www.automicvault.com/zh-hans/pkg/brew/docfx/) - Shares av.db curated category or tags: api-docs, cli, developer-tools, documentation. - [doxygen](https://www.automicvault.com/zh-hans/pkg/brew/doxygen/) - Shares av.db curated category or tags: api-docs, cli, developer-tools, documentation. - [gi-docgen](https://www.automicvault.com/zh-hans/pkg/brew/gi-docgen/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator. - [helm-docs](https://www.automicvault.com/zh-hans/pkg/brew/helm-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator. - [help2man](https://www.automicvault.com/zh-hans/pkg/brew/help2man/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator. - [naturaldocs](https://www.automicvault.com/zh-hans/pkg/brew/naturaldocs/) - Shares av.db curated category or tags: cli, developer-tools, documentation, documentation-generator. - [jsdoc](https://www.automicvault.com/zh-hans/pkg/npm/jsdoc/) - Executable or command metadata overlaps with this package. Shared terms: api, api-docs, cli, developer, developer-tools. ## Combined YAML source View the package source record on GitHub. [combined/jsdoc3.yml](https://github.com/automic-vault/db/blob/main/combined/jsdoc3.yml) ## 来源 - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph