博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
JS基础【JSDoc的常用指令】
阅读量:6573 次
发布时间:2019-06-24

本文共 2871 字,大约阅读时间需要 9 分钟。

  hot3.png

JSDoc 3 Tag DictionaryInline tagsAll about inline tags {@link ...}, {@linkplain ...}, {@linkcode ...}, {@tutorial ...}.@abstractThis member must be implemented (or overridden) by the inheritor.@accessSpecify the access level of this member - private, public, or protected.@aliasTreat a member as if it had a different name.@augmentsThis object adds onto a parent object.@authorIdentify the author of an item.@borrowsThis object uses something from another object.@callbackDocument a callback function.@classdescUse the following text to describe the entire class.@constantDocument an object as a constant.@constructorThis function is intended to be called with the "new" keyword.@constructsThis function member will be the constructor for the previous class.@copyrightDocument some copyright information.@defaultDocument the default value.@deprecatedDocument that this is no longer the preferred way.@descDescribe a symbol.@enumDocument a collection of related properties.@eventDocument an event.@exampleProvide an example of how to use a documented item.@exportsIdentify the member that is exported by a JavaScript module.@externalDocument an external class/namespace/module.@fileDescribe a file.@firesDescribe the events this method may fire.@globalDocument a global object.@ignore[todo] Remove this from the final output.@innerDocument an inner object.@instanceDocument an instance member.@kindWhat kind of symbol is this?@lendsDocument properties on an object literal as if they belonged to a symbol with a given name.@license[todo] Document the software license that applies to this code.@linkInline tag - create a link.@memberDocument a member.@memberofThis symbol belongs to a parent symbol.@methodDescribe a method or function.@mixesThis object mixes in all the members from another object.@mixinDocument a mixin object.@moduleDocument a JavaScript module.@nameDocument the name of an object.@namespaceDocument a namespace object.@paramDocument the parameter to a function.@privateThis symbol is meant to be private.@propertyDocument a property of an object.@protectedThis member is meant to be protected.@publicThis symbol is meant to be public.@readonlyThis symbol is meant to be read-only.@requiresThis file requires a JavaScript module.@returnsDocument the return value of a function.@seeRefer to some other documentation for more information.@sinceWhen was this feature added?@staticDocument a static member.@summaryA shorter version of the full description.@thisWhat does the 'this' keyword refer to here?@throwsDescribe what errors could be thrown.@todoDocument tasks to be completed.@tutorialInsert a link to an included tutorial file.@typeDocument the type of an object.@typedefDocument a custom type.@variationDistinguish different objects with the same name.@versionDocuments the version number of an item.

转载于:https://my.oschina.net/parker/blog/152398

你可能感兴趣的文章
我的友情链接
查看>>
练习6
查看>>
Linux清除用户登录记录和命令历史方法
查看>>
第五章 shell学习之文件的排序、合并和分割
查看>>
翻译 Windows Server 2016和System Center 2016 技术预览版4 使创新更容易
查看>>
我的友情链接
查看>>
smokeping 安装与配置
查看>>
nginx访问控制allow、deny(ngx_http_access_module)
查看>>
EIGRP MD5认证实例
查看>>
提示,请选择有效的文件
查看>>
Android 使用Nginx rtmp 模块
查看>>
Postfix
查看>>
调查称谷歌占北美25%互联网流量
查看>>
Linux链接文件、管道、重定向讲解
查看>>
Ubuntu的一些常用快捷键
查看>>
svn 钩子开启
查看>>
关于 动态分流系统 ABTestingGateway 的想法
查看>>
Redis 网络编程
查看>>
解决Exchange用户邮箱别名为乱码的问题
查看>>
MyBatis配置详解
查看>>