JSDOC常用注释

常用标签

@module
标明当前文件模块,在这个文件中的所有成员将被默认为属于此模块,除非另外标明

@submodule
针对模块的划分,处于@module之下

@class

标示一个类或者一个函数

@constructor

当使用对象字面量形式定义类时,可使用此标签标明其构造函数

@callback

标明此方法是一个回调函数

@event

标明一个可触发的事件函数,一个典型的事件是由对象定义的一组属性来表示。

@constant

常量标识

@member/@var

记录一个基本数据类型的成员变量

@method

标记一个方法或函数

@param

标记方法参数及参数类型

@property

标明一个对象的属性

@readonly

只读

@return

标明返回值、类型及描述

@type

描述代码变量的类型

@description

如果在注释开始描述可省略此标签

@enum

一个类中属性的类型相同时,使用此标签标明

@example

示例,代码可自动高亮

@exports

标识此对象将会被导出到外部调用

@ignore

忽略此注释块

@link

内联标签,创建一个链接,如 {@link http://github.com Github}

@name

指定一段代码的名称,强制 JSDoc 使用此名称,而不是代码里的名称

@namespace

指定一个变量为命名空间变量

@static

描述一个不需实例即可使用的变量

@summary

对描述信息的短的概述

@throws

描述方法将会出现的错误和异常

@todo

描述函数的功能或任务

@tutorial

插入一个指向向导教程的链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 178,118评论 25 709
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,423评论 19 139
  • 前言 人生苦多,快来 Kotlin ,快速学习Kotlin! 什么是Kotlin? Kotlin 是种静态类型编程...
    任半生嚣狂阅读 26,631评论 9 118
  • 在浏览器打开React单页应用,习惯上会把整个应用所有的JS文件一次性加载完。什么?暂时不需要的JS文件也要加载,...
    一米米尺阅读 1,397评论 2 2
  • 今天小妮子和王同学要来长沙准备明天的考试,尽管后天要交论文了,尽管我还没用知网查重也不想,尽管之前时间一大把,...
    辛德瑞拉_7d9e阅读 210评论 0 0

友情链接更多精彩内容