Typedoc 教程
TypeDoc是一个文档API生成器，用于为typecript应用程序生成文档。这与JSDoc、ESdoc和JavaDoc类似。
任何项目的文档都是成功的应用开发的关键因素之一。Type doc工具将typescript文件或typescript项目作为输入，解析它并生成不同格式的文档作为输出。HTML是生成的格式之一，它包含链接、样式和代码的HTML。
这将通过阅读typescript代码元素如类、接口和方法来生成。
安装和设置
Type doc可以作为独立的NPM命令行使用，也可以与webpack gulp和grunt工具集成在一起 在安装typedoc之前，首先需要安装nodejs，npm和node命令应该成功运行。-g选项将在全局安装，没有-g选项和-save-dev选项则在本地安装。
这将在全球范围内安装，typedoc命令将可用:
B:\Workspace\blog>typedoc --version
TypeDoc 0.12.0
Using TypeScript 3.0.3 from C:\Users\Kiran\AppData\Roaming\npm\node_modules\typedoc\node_modules\typescript\lib
你也可以通过以下配置来配置typedoc命令并作为npm命令运行 在package.json中添加以下条目
"scripts":{
"tdocs":"npm run typedocs [options] "
}
一旦添加了配置，你可以通过npm命令 "npm tdocs "运行
typedoc选项
typedoc命令提供的选项是一个双连字符（-）。
选项:
描述
输出:
它是输出目录，为其生成文档。
模式:
编译后的项目即文件或模块的输出模式
主题:
为生成的文档模板指定主题，可以是默认的，最小的，或自定义主题的路径
目标:
配置需要与之编译的EcmaScript js版本ES5、ES6
包括:
它包括所有用于生成的文件
排除:
排除用于生成的所有文件
typedoc 示例
我们将看到我们如何为Typescript文件生成一个文档。首先创建typescript文件 - Animal.ts
class Animal {
public nonveg:boolean;
constructor() {
console.log("new animal created");
}
eat():void{
console.log("new animal Eat method");
}
}
class Lion extends Animal {
constructor() {
super();
this.nonveg = true;
}
eat():void{
console.log("Lion Eat method");
}
}
class Cat extends Animal {
constructor() {
super();
this.nonveg = true;
}
eat():void{
console.log("Cat Eat method");
}
}
生成Html文档
使用typedoc命令，请发出以下命令
生成的文档输出如下截图
Typedoc带有tdconfig.json文件，包含生成文档所需的配置选项。这个文件包含typescript编译器选项和包括哪些文件来生成文档 排除选项是排除生成的文件。
Typedoc捆绑器插件
Typedoc也可以和JavaScript构建工具一起使用。已经有插件npm包可用。
- Grunt - grunt-typedoc
- Gulp - gulp-typedoc
- Webpack - typedoc-webpack-plugin
我将在未来的文章中发布这些插件的例子。
