美文网首页
自动生成文档-jsDoc

自动生成文档-jsDoc

作者: 一点金光 | 来源:发表于2018-09-19 17:44 被阅读0次

快速入门

# 编写注释
/**
 * Represents a book.
 * @constructor
 */
function Book(title, author) {
}
# 生成文档
jsdoc book.js

编写注释

# 描述

# 标签
/** @constructor */

# 路径
Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."

生成文档

# 参数

配置文件

# 文件格式

# 默认选项

# 使用插件

# 遍历深度

# 指定输入

# 源码类型

# 标签控制

# 配置模板

配置模板


块级标签


行内标签


使用插件

创建

使用

使用指南



http://usejsdoc.org

相关文章

  • 利用jsdoc为vue项目生成漂亮的文档

    jsdoc是前端自动生成文档所常用的工具。我们只要按照jsdoc的语法来书写注释就能顺利的生成一片很漂亮的文档。 ...

  • 自动生成文档-jsDoc

    快速入门 编写注释 生成文档 配置文件 配置模板 块级标签 行内标签 使用插件 使用指南 http://usejs...

  • JSDoc自动生成API文档

    参考:https://www.shouce.ren/api/view/a/13232[https://www.sh...

  • webstorm中生成jsdoc注释文档的方法

    webstorm中生成jsdoc注释文档的方法 生成如下下图的文档格式 使用到的文档 jsdoc非常简单易懂的使用...

  • 实践|开始使用JsDoc

    JsDoc可以根据规范化的注释、自动生成接口文档。包括参数说明、示例等等。 一、安装 二、制作第一份文档 只有一个...

  • 项目中用到的jsdoc用法

    项目中用到的jsdoc用法 jsdoc 文档jsdoc 文档 tags 标签说明 React组件的文档写法 现有组...

  • JS 文档生成工具:JSDoc 介绍

    JSDoc是一个根据javascript文件中注释的信息,生成API文档的工具。生成的文档是html文件。类似 J...

  • JSDoc 注释规范

    JSDoc 注释规范 什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 Ja...

  • jsdoc3详细入门(图文)

    jsdoc3是一个比较方便的js代码生成文档工具。通过在代码中加入规范化的注释可以快速生成合适的接口文档,许多ID...

  • 用apidoc生成webAPI文档

    起初了解到生成API文档工具有jsdoc、YUI、jsduck,最后选择jsduck来试验,原因有: 1.与jsd...

网友评论

      本文标题:自动生成文档-jsDoc

      本文链接:https://www.haomeiwen.com/subject/dvikmftx.html