jsDoc的使用文档

个人的总结，有不准确的地方欢迎大家留言指出

安装
- npm init -y
- npm i -D jsdoc
  - package.json中可以看到jsdoc的版本信息
- 新建一个jsdoc.json文件
  - {
    “source”:{
    “include”:[“src”],
    “includePattern”:".js$",
    “excludePattern”:"(node_modules/docs)"
    },
    “plugins”:[“plugins/markdown”],
    “templates”:{
    “cleverLinks”:true,
    “monospaceLinks”:true
    },
    “opts”:{
    “recurse”:true,
    “destination”:"./docs/",
    “template”:“custom-template”
    }
    }
- 修改package.json文件
  - “scripts”: {
    “doc”: “jsdoc -c jsdoc.json”
    },
- 新建src文件夹，输入skmap.js文件(输入文档必须是js类型不能是html类型)，执行npm run doc
- 回车后，在当前项目文件根目录下会生成一个docs文件夹，里面有3个文件夹fonts、scripts、styles分别是生成文档的字体、脚本和css样式,根目录下的html文档文件就是JSDoc文档，在浏览器中打开该文件
格式
/**
- @标签文档内容
  */
常用功能标签：
desc/description 描述方法、变量，放在第一排可省略
method/function 方法名
param 参数，可定义类型
property 属性，可定义类型
return 方法返回值，可定义类型
todo 描述函数的功能
global 表示变量是否是全局
constructs 表明是构造函数
default 默认值
alias 别名
event 事件
example 示例
type 变量类型
module 标明当前文档模块文档信息标签
version 版本信息
author 作者
license 开源协议
link 链接
使用
- 变量声明
  //@ts-check
  - /**
    *Name
    *@type {string}------------表示name这个变量的类型只能是字符串类型
    */
    const name=‘Joe’
  - /**
    *Array of grades
    *@type {Array}------------表示grades这个变量的类型只能是数组类型,且数组中只能是数字类型的值，可以不加限定条件
    */
    const grades=[98,85,73,99]
  - /**
    *todo object描述
    *@type {{id:number,text:string}}------------表示todo这个变量的类型只能是object,而且限定了键值对的类型
    */
    const todo={
    id:1,
    text:“Hello”
    }
- 函数声明
  - /**
    *total带参函数的描述
    *@param {number} amount --amount参数的类型
    *@param {number} item --item参数的类型
    *@returns {string} --函数返回值类型
    *@example 举例子
    */
    const total = (amount,item)=>{
    return ${amount+item*amount};
    }
    console.log(total(20,0.5));
- 构造函数声明
  - /**
    *@class
    */
    function thrdLayerHelper(sgs) {
    this.sgs = sgs;
    this.shape= null;
    }
    thrdLayerHelper.prototype.createCircle，如在构造函数原型上加的方法以函数声明中编写的规范进行注解
- 模块(js文件)引入
  - 导出模块 @module mokuai(文件名称)
    /**
    *@param {number} n1 --n1参数的类型
    *@param {number} n2 --n2参数的类型
    *@returns {number}
    */
    exports.add = (n1,n2)=>n1+n2
  - 在需要引入的地方按需引入
    const {add}=require (‘mokuai’);

jsDoc的使用文档相关推荐

利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览
### 利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览 http://segmentfault.com/a/1190000002583569 转载于:https://www.cnb ...
JSDoc --JS API文档生成器
JSDoc 是一个JavaScript的API文档生成器. 他可以让开发者在开发的过程中, 将编写的注释通过JSDoc工具生成一个api文档, 妈妈再也不用担心我不会写接口文档了. 这里是原作者Git ...
Vue项目 *.js 使用 jsdoc 生成 JavaScript 文档
一.安装 jsdoc npm install --save-dev jsdoc 二.配置 jsdoc.json {"source": {"include": [ ...
jsdoc api文档_创建更好的JSDoc文档
jsdoc api文档 Writing code documentation is one of the most relaxing experiences of my work as a back ...
JS-ES6 jsdoc通过注解生成-更具规格的API文档
前言: 在敏捷开发的过程中或者说是项目后期维护的过程中,文档是必不可少的,可以避免过多的交流从而加快项目的速度,今天介绍的就是一款基于前端的工具jsdoc,他能够根据代码中的注释很快生成API文档,只 ...
常用工具说明--jsdoc 前端文档输出工具
1.利用npm安装jsdoc模块 npm install jsdoc -g 2.由于jsdoc默认的生成文档模板不好看,可以下载一套好看些的模板,如 jaguar.js 下载地址:https://gi ...
JSDoc入门使用指南 -- 手摸手教你用JSDoc（超好用的js文档生成工具）
安装准备 Node.js 8.15.0+ 通过npm安装全局安装:npm install -g jsdoc 若出现权限问题,如 EACCES报错,最佳实践为用node版本管理器(nvm等)重装np ...
jsdoc接口文档生成器
jsdoc 官方文档 https://jsdoc.app/ 快速入门需要安装node.js 及npm 环境 step.1 安装创建一个新文件夹myJsdoc mkdir myJsdoc cd my ...
ts 项目执行js_TypeScript项目的文档和测试
1. 使用typedoc生成typescript项目文档针对typescript项目可以使用typedoc来生成文档,typedoc可以全局也可以本项目安装. npm install typedoc ...
基于GitBook框架搭建技术文档平台
源宝导读:为了向用户更好的传递ERP开放平台的价值与技术知识,我们基于GitBook框架搭建了一个文档中心站点,本文将介绍此站点的设计与实现过程. 一.项目架构图因为文档会涉及到很多的产品线,所以目 ...

jsDoc的使用文档

jsDoc的使用文档相关推荐

最新文章

热门文章