documentation 中文文档教程

Question

现代 JavaScript 的文档系统

:date: 当前维护状态

• Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations.
• Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
• Integrates with GitHub to link directly from documentation to the code it refers to.
• Customizable output: HTML, JSON, Markdown, and more

Examples

• HTML output with default template
• Markdown
• JSON

Documentation

• Getting Started: start here
• Usage: how to use documentation.js
• Recipes: tricks for writing effective JSDoc docs
• Node API: documentation.js's self-generated documentation
• Configuring documentation.js
• FAQ
• Troubleshooting
• Theming: tips for theming documentation output in HTML
• See also: a list of projects similar to documentation.js

User Guide

使用 npm 包管理器全局安装 documentation：

$ npm install -g documentation

这会安装一个名为 documentation 在你的路径中，你可以 指向 JSDoc 注释的源代码以生成 人类可读的文档。 首先，使用 --help 运行 documentation 寻求帮助的选项：

Usage:

# generate markdown docs for index.js and files it references
documentation build index.js -f md

# generate html docs for all files in src, and include links to source files in github
documentation build src/** -f html --github -o docs

# document index.js, ignoring any files it requires or imports
documentation build index.js -f md --shallow

# build and serve HTML docs for app.js
documentation serve app.js

# build, serve, and live-update HTML docs for app.js
documentation serve --watch app.js

# validate JSDoc syntax in util.js
documentation lint util.js

# update the API section of README.md with docs from index.js
documentation readme index.js --section=API

# build docs for all values exported by index.js
documentation build --document-exported index.js

# build html docs for a TypeScript project
documentation build index.ts --parse-extension ts -f html -o docs

Commands:
  serve [input..]   generate, update, and display HTML documentation
  build [input..]   build documentation
  lint [input..]    check for common style and uniformity mistakes
  readme [input..]  inject documentation into your README.md

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Contributing

我们有很多 问题我们会 喜欢帮助。

• Robust and complete JSDoc support, including typedefs.
• Strong support for HTML and Markdown output
• Documentation coverage, statistics, and validation

文档是一个开放的开源项目。 这意味着：

做出重大和有价值贡献的个人将获得奖励 提交-访问项目以在他们认为合适的时候做出贡献。 这 项目更像是一个开放的 wiki，而不是一个标准的受保护的开源项目。