美文网首页
jsdoc写作规范

jsdoc写作规范

作者: 随心_be4f | 来源:发表于2018-02-12 17:27 被阅读0次

1,注释规范:

    使用/** 开头注释


2,几个重点标签:

    @author  作者,方便定位

    @class @constructor  标记类和构造函数

    @constant @const常量标记

    @description @desc 对内容进行描述

    @module 模块名称

    @enum 枚举类型标记

    @global 全局对象标记

    @param 函数参数标记

    @returns @return 函数返回标记

    @this this指向标记

    @see 参考链接

    @memberof 标记模块间的从属关系

    @event 在模板中标记可以被触发的事件,与@fire配合使用

3,如何注释代码

    以.vue组件为例:

    1,模块注释:

        @module 注明模块名

    上面一行默认是描述信息

模块注释

    2, 方法注释

        使用@method注释方法,后面跟方法名,使用@param注释方法的参数,@param {} xxx格式,{}中填写参数类型(如有则填写),xxx为方法值和描述信息,格式为方法名  方法描述(中间以空格隔开)

方法注释

    3,props属性注释

        使用@props属性注释,注释格式如下

    

4,docs生成命令

npm run docs

5,配置详解:

在jsdoc-vue目录下的jsdoc-vue.conf.js里面配置需要处理的文档路径

jsdoc配置文件

include表示需要处理的目录,

exclude代表排除目录,

includePattern使用正则表达式匹配,只处理匹配到的文件类型

附jsdoc参考链接:

jsdoc中文APi

相关文章

  • jsdoc写作规范

    1,注释规范: 使用/** 开头注释 2,几个重点标签: @author 作者,方便定位 @class...

  • JSDoc 注释规范

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

  • JSDoc

    编写JSDoc是为了增强代码的可读性,以及方便导出API文档。它的规范可参考JSDoc 3 @descriptio...

  • JsDoc常用注释规范

    什么是JsDoc,请移步[https://jsdoc.app/index.html]接下来我们来看常用的jsDoc...

  • jsdoc的使用

    JSDoc使用指南 1.JSDoc安装和配置: JSDoc安装:使用npm安装npm install jsdoc ...

  • 个人笔记|JSDoc注释规范

    一般放在需要解释的代码前面 以/**开始 多一个少一个*都不是JSDoc了 参考:Use JSDoc文档[http...

  • 项目中用到的jsdoc用法

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

  • 一些JSdoc的规范

    (1)默认值 @param {number} [foo=1] (2) 可选参数 @param {number} ...

  • JSDoc

    JSDoc[https://jsdoc.app/] 是许多代码库中使用的一种流行的内联文档方法。 编写 JSDoc...

  • JSdoc @module 中文跳转路径错误修复

    找到node_modules/jsdoc/lib/jsdoc/util/templateHelper.js,第35...

网友评论

      本文标题:jsdoc写作规范

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