Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档

最新推荐文章于 2024-10-10 07:15:06 发布

爱宇阳

最新推荐文章于 2024-10-10 07:15:06 发布

阅读量2.9k

点赞数

分类专栏： Vue JavaScript 文章标签： jsdoc vue

本文链接：https://blog.csdn.net/qq_34707272/article/details/107616393

版权

Vue 同时被 2 个专栏收录

83 篇文章 11 订阅

订阅专栏

JavaScript

43 篇文章 2 订阅

订阅专栏

一、安装 jsdoc

npm install --save-dev jsdoc

二、配置 jsdoc.json

{
  "source": {
    "include": [ "src/" ],
    "exclude": [ "src/router" ]
  },
  "opts": {
    "template": "node_modules/docdash",
    "encoding": "utf8",
    "destination": "./docs/",
    "recurse": true,
    "verbose": true
  }
}

配置项

source

source.include JSDOC 需要扫描哪些文件

source.exclude JSDOC 需要排除哪些文件

opts

opts.template   生成文档的模板，默认是 templates/default

opts.encoding   读取文件的编码，默认是 utf8

opts.destination  生成文档的路径，默认是 ./out/

opts.recurse 运行时是否递归子目录

opts.verbose 运行时是否输出详细信息，默认是 false

三、配置 package.json 的 scripts

"scripts": {
  "dev": "vue-cli-service serve",
  "build": "vue-cli-service build",
  "build:doc": "jsdoc -c ./jsdoc.json",
},

四、JavaScript 文件使用 /** 注释

/**
 * 解析日期时间到时间戳
 * @param date {Date} 日期时间
 * @param digits {Boolean} 是否是10位时间戳
 * @returns {number}
 */
export function dateParseTime(date, digits = true) {
  return digits ? Date.parse(new Date(date)) / 1000 : Date.parse(new Date(date));
}

五、npm run build:doc 生成 JavaScript 文档

六、更多请查看文档

/**
 * @author LiuDanyang
 * @class
 * @name 登录
 * @description 登录类
 * @param {String} 用户名
 * @param {String} 密码
 * @return {Login}
 *
 * @example
 * // 创建登录
 * new Login(user, pass);
 */
export default class Login {

  /**
   * @private
   * @function
   * @name 初始化
   * @description 初始化登录
   */
  init() {

  }
}

参考资料：

JSDoc中文文档、JSDoc官网、Github jsdoc