语言►JSDoc

什么是JSDoc

本文作者: jsweibo

本文链接: https://jsweibo.github.io/2019/07/14/%E4%BB%80%E4%B9%88%E6%98%AFJSDoc/

摘要

本文主要讲述了：

  1. 什么是 JSDoc
  2. 语法
  3. 安装
  4. 生成文档

正文

什么是 JSDoc

JSDoc 是 Javascript 源代码的标记语言（特殊格式的注释）

简单说，JSDoc 可以用于描述函数的作用、参数列表、返回值

语法

基本规则

  • JSDoc 注释必须置于被注释代码的前面
  • 每个注释必须以/**开头

示例：

单行：

1
2
/** 这是foo()的描述 */
function foo() {}

多行：

1
2
3
4
/**
 * 这是foo()的描述
 */
function foo() {}

JSDoc 标签

JSDoc 标签用于提供更多信息。

示例：

  • @constructor表示构造函数
  • @param表示参数
1
2
3
4
5
6
7
/**
 * 表示一本书
 * @constructor Book
 * @param {string} title - 书的标题
 * @param {string} author - 书的作者
 */
function Book(title, author) {}

安装

在注释写好之后，下面我们来安装jsdoc，它的作用是从源文件中将注释提取出来并生成文档。

注意：JSDoc 是标记语言，jsdoc是工具。

局部安装

1
2
3
#!/usr/bin/env bash

npm install --save-dev jsdoc

生成文档

1
2
3
#!/usr/bin/env bash

jsdoc book.js

此命令会在 CWD 下创建out/，并将文档置于其中。

参考资料

本文作者: jsweibo

本文链接: https://jsweibo.github.io/2019/07/14/%E4%BB%80%E4%B9%88%E6%98%AFJSDoc/

本文对你有帮助？请支持我

支付宝
微信