「 TypeScript 项目的文档生成器 」
| 翻译的原文 | 与日期 | 最新更新 | 更多 |
|---|---|---|---|
| commit | ⏰ 2018-12-11 |  |
中文翻译 |
欢迎 👏 勘误/校对/更新贡献 😊 具体贡献请看
If help, buy me coffee —— 营养跟不上了，给我来瓶营养快线吧! 💰
TypeScript 项目的文档生成器.
TypeDoc 在 Node.js 上运行,可作为 NPM 包使用.您可以像往常一样在项目目录中安装 TypeDoc:
$ npm install typedoc --save-dev与 TypeScript 编译器一样，TypeDoc 附带一个二进制文件,如果将 TypeDoc 安装为全局模块,则可以从任何位置调用该二进制文件。可执行文件的名称是typedoc.
$ npm install typedoc --global
$ typedoc友情提示: https://typedoc.org/api/ 官方文档 由 typedoc/example/self自身 生成
TypeDoc 接受 TypeScript 编译器接受的大多数命令行参数。一个主要区别是,可以将整个目录，而不是单个文件传递给文档生成器。因此,要为整个项目创建文档,只需键入:
$ typedoc --out path/to/documentation/ path/to/typescript/project/从版本 0.2 开始,TypeDoc 不再能够预测文件是应该被视为模块，还是应该将项目编译成一个大的命名空间。你必须指定mode参数改变 TypeDoc 的行为。
| 名 | 曰 |
|---|---|
- --out <path/to/documentation/> |
指定文档应写入的位置. |
| - `--mode <file | modules>` |
- --options |
指定应加载的 js 选项文件。如果未指定,TypeDoc 将在当前目录中查找"typedoc.js". |
- --json <path/to/output.json> |
指定描述项目写入的 json 文件的位置和文件名。指定时,不会生成任何文档. |
- --ignoreCompilerErrors |
即使编译器返回错误,TypeDoc 是否仍会生成文档页面? |
| 名 | 曰 |
|---|---|
- --exclude <pattern> |
当路径作为源提供时,按给定模式排除文件。支持标准 minimatch 模式(参见#170) |
- --includeDeclarations |
打开 .d.ts 声明文件的解析. |
- --externalPattern <pattern> |
为应该被视为外部的文件,定义一个模式. |
- --excludeExternals |
防止记录外部解析的 TypeScript 文件. |
- --excludePrivate |
防止私有成员包含在生成的文档中. |
- --excludeProtected |
防止受保护的成员包含在生成的文档中. |
| 名 | 曰 |
|---|---|
- --module <commonjs, amd, system or umd> |
指定模块代码生成:"commonjs","amd","system"或"umd". |
- --target <ES3, ES5, or ES6> |
指定 ECMAScript 目标版本:"ES3"(默认),"ES5"或"ES6" |
- --tsconfig <path/to/tsconfig.json> |
指定应加载的 typescript 配置文件.如果未指定,TypeDoc 将在当前目录中查找"tsconfig.json". |
| 名 | 曰 |
|---|---|
| - `--theme <default | minimal |
- --name <Documentation title> |
设置将在模板标题中，使用的项目的名称. |
| - `--readme <path/to/readme | none>` |
- --plugin |
指定应加载的 npm 插件，省略加载所有已安装的插件,设置为"none"以不加载任何插件. |
- --hideGenerator |
不要在页面末尾打印 TypeDoc 链接. |
- --gaID |
设置 Google Analytics 跟踪 ID 并激活跟踪代码. |
- --gaSite <site> |
设置 Google Analytics 的网站名称。默认为auto |
- --entryPoint <fully.qualified.name> |
指定根符号的完全规范名称。默认为全局命名空间. |
| - `--gitRevision <revision | branch>` |
| 名 | 曰 |
|---|---|
--includes <path/to/includes> |
指定查找包含文档的位置。一种是在注释中使用[[include:FILENAME]]，包括来自此位置的文档. |
--media <path/to/media> |
指定应复制到输出目录的媒体文件的位置。要创建媒体文件的链接,请在注释中使用该模式media:https://FILENAME. |
| 名 | 曰 |
|---|---|
--version |
显示 TypeDoc 的版本号. |
--help |
显示所有 TypeDoc 选项. |
Microsoft 创建的， Webpack 插件可以运行 TypeDoc 。你可以在 NPM 上找到它: https://www.npmjs.com/package/typedoc-webpack-plugin |
由 Rogier Schouten 创建， Gulp 插件可以运行 TypeDoc。你可以在 NPM 上找到它: https://www.npmjs.com/package/gulp-typedoc/
由 Bart van der Schoor 创建的，Grunt 插件可以运行 TypeDoc 。你可以在 NPM 上找到它: https://www.npmjs.com/package/grunt-typedoc
- External Module Name >< 外部模块名称- 设置 TypeDoc 外部模块的名称
- Sourcefile URL >< 源文件 URL- 设置自定义源文件 URL 链接
- Internal/External Module >< 内/外部 模块- 明确将模块标记为
@internal或@external - Single Line Tags >< 单行标签- 处理指定的
@tags作为单行 - Localization >< 国际化- 生成不同语言的文档
可以在 NPM 上找到所有已发布的 Typedoc 插件的列表: https://www.npmjs.com/search?q=keywords:typedocplugin
访问我们的主页以获取高级指南和广泛的 API 文档: http:https://typedoc.org
该项目由开发人员社区维护.欢迎并赞赏我们的贡献.你可以在 GitHub 上找到 TypeDoc;随意启动问题或创建拉取请求: https://github.com/TypeStrong/typedoc
有关更多信息,请阅读贡献 指南.
版权所有(c)2015Sebastian Lenz。版权所有(c)2016-2018TypeDoc Contributors.根据 Apache License 2.0 许可.