jsdoc写作规范

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

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,952评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,387评论 25 708
  • 方法数超过65535引出的问题 随着Android开发过程中,各类第三方库的加入,导致整个项目的方法数在不知不觉中...
    Obeli5k阅读 1,042评论 0 0
  • 华夏出真龙, 其名为泽东。 万民皆敬仰, 东方从此红。 胆识智谋无人匹, 文治武功皆第一。 豪气冲天凌云志, 后使...
    半个读书人阅读 320评论 11 32