专栏首页方球typedoc typescript 注释文档生成器

typedoc typescript 注释文档生成器

image.png

安装

cnpm i --dev typedoc or yarn add --dev typedoc

使用

// 指定生成对象 typedoc file.ts // 指定输出目录 typedoc --out ./docs

默认将在根目录生成文档目录 /docs

注释规则

/**
 * 首行功能名称
 * @param 参数说明
 * @typeParam 类型参数
 * @return(s) 返回说明
 * @event 事件说明
 * @hidden @ignore 跳过
 * @interval 内部代码,如果配置了 excludeInternal 该段将被忽略
 * @category 反射分组
 */

// 其他
/**
 * @prop 属性
 * @example 使用例子
 */


// 代码块,使用markdown语法
/**
 * ``` typescript
 * class Man { ... }
 * ```
 */
### 注释例子
/**
 * 文本节点
 * @param tag 节点内容
 * @return 返回文本节点字符
 * @example
 * ``` typescript
 * 1. textTag(null)
 * => ''
 * 
 * 2. textTag(undefined)
 * => ''
 * 
 * 3. textTag({ name: 'coco' })
 * => `
 *    {
 *      name: 'coco' 
 *    }
 *  `
 * 
 * 4. textTag('container')
 * => 'container'
 * 
 * 5. textTag(() => {...})
 * => '() => {...}'
 * ```
 */

配置项目

tsconfig

使用 tsconfig 配置文件规则

 typedoc --tsconfig </path/to/tsconfig.json>

entryPoints

入口地址

$ typedoc a b
# or
$ typedoc --entryPoints a --entryPoints b

exclude

排除规则,排除不需要生成的文件

typedoc --exclude "**/*+(index|.spec|.e2e).ts"

excludePrivate

不生成类的 Private 属性文档

 typedoc --excludePrivate

excludeProtected

不生成 类的 Protected 属性文档

typedoc --excludeProtected

excludeInternal

排除内部信息

typedoc --excludeInternal

media

注入多媒体文件地址

typedoc --media <path/to/media/>

includes

注入其他文档地址, 例如 markdown 文件

typedoc --includes <path/to/includes/>

out

文档输出目录

typedoc --out <path/to/documentation/>

json

输出 json 文件

typedoc --json <path/to/out-file.json>

emit

typedoc --emit

theme

设置主题

typedoc --theme <default|minimal|path/to/theme>

highlightTheme

设置高亮主题

typedoc --highlightTheme dark-plus

watch

监听生成

typedoc --watch

使用配置文件

// typedoc.config.json
{
  "entryPoints" : "./src",
  "exclude": "**/__test__/*.ts",
  "out": "./docs"
}
// package.json
"doc:build": "typedoc --options ./typedoc.config.json",

配合构建工具使用

Gulp

// 安装插件
npm install --save-dev gulp-typedoc
// 添加任务
var typedoc = require("gulp-typedoc");
gulp.task("typedoc", function () {
  return gulp.src(["src/**/*.ts"] // 入口).pipe(
    typedoc({
      // 文档生成配置
      out: "docs/",
      name: "My project title",
    })
  );
});

参考

官方文档

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 轻量级 Node.js Web 框架 Daruk2.0 正式版发布了!

    Daruk 是一款基于 Koa2,使用 Typescript 开发的轻量级 web 框架。Daruk 的初衷是让人们可以更方便的开发 Nodejs Web 应用...

    五月君
  • Lua生成的LDoc文档注释规范

    函数参数@param 是不指明具体类型的, 若想指明的话可以用 @int, @string, @bool, @func, @tab, @thread 几个标签来...

    bering
  • .Net魔法堂:提取注释生成API文档

    一、前言                                 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要。通过文档我们快速...

    ^_^肥仔John
  • 基于TypeScript封装Axios笔记(一)

    我们开始初始化项目,首先我们先去 GitHub 上创建一个 repo,填好 repo 名称,以及写一下 README,对项目先做个简单的描述。

    用户7572539
  • Python 文档生成器 mkdocs

    mkdocs 是一个基于Python 对 Markdown 非常友好的文档生成器,中文文档地址

    苏生不惑
  • 1.8W字|了不起的 TypeScript 入门教程(第二版)

    阿宝哥第一次使用 TypeScript 是在 Angular 2.x 项目中,那时候 TypeScript 还没有进入大众的视野。然而现在学习 TypeScri...

    阿宝哥
  • 你可能已经忽略的git commit规范

    在日常的开发工作中,我们通常使用 git 来管理代码,当我们对代码进行某项改动后,都可以通过 git commit 来对代码进行提交。

    前端森林
  • IDEA操作知识点——如何使用idea生成注释文档JavaDoc

    用户7073689
  • Django之Admin文档生成器

    Django的admindocs应用可以从模型、视图、模板标签等地方获得文档内容。

    菲宇
  • IDEA操作知识点——使用idea生成注释文档JavaDoc出现错误

    这是由于idea自带的jdk的版本是11,版本比较高,但是没有jre。 这里需要我们更改成自己的jdk1.8版本. 方法如下:

    用户7073689
  • NDoc - .NET 代码文档生成器

    NDoc 可以将 C#.NET 编译生成的程序集和对应的 /doc XML 文档,自动转换成如 .NET Framework SDK 类库文档或者 MSDN L...

    张善友
  • 十分钟了解 TypeScript 是如怎样工作的

    本文概述了 TypeScript 的工作原理:典型的 TypeScript 项目的结构是什么?什么被编译以及怎样编译?我们如何使用 IDE 编写 TypeScr...

    疯狂的技术宅
  • 从 0 到 1 搭建一个企业级前端开发规范

    https://juejin.cn/post/6947872709208457253

    @超人
  • 基于 TypeScript 的 Weex 优化实践

    Weex 作为一种成熟的跨平台程序框架被运用到许多产品中,有赞也不例外。有赞零售移动端团队从 2018 年就开始使用 Weex 构建页面,据不完全统计,有赞零售...

    有赞coder
  • mybatis generator 生成 实体类 中文注释 原

    首先 找到 org.mybatis.generator.core_1.3.5.201609070108.jar (位于eclipse\plugins)

    北漂的我
  • pycharm使用笔记3-自动生成文件注释和函数注释

    版权声明:本文为博主原创文章,未经博主允许不得转载。python版本为python3,实例都是经过实际验证。 ...

    锦小年
  • React组件设计实践总结01 - 类型检查

    最近准备培训新人, 为了方便新人较快入手 React 开发并编写高质量的组件代码, 我根据自己的实践经验对React 组件设计的相关实践和规范整理了一些文档, ...

    _sx_
  • JDoc1.0发布 文档生成利器 原

    JDoc是基于JAVA开发的,针对主流web框架做的接口文档生成利器,只需极简配置就可以实现文档的生成,且对项目零入侵,主要目的是解决协作开发中接口文档及时更新...

    用户2603479
  • Angular 工具篇之文档管理

    本文我们将介绍 Compodoc 这款工具,它用于为 Angular 应用程序生成静态文档。Compodoc 能够帮助 Angular开发人员为他们的应用程序生...

    阿宝哥

扫码关注云+社区

领取腾讯云代金券