JS基础【JSDoc的常用指令】
2013-08-13 16:20
363 查看
JSDoc 3 Tag Dictionary Inline tags All about inline tags {@link ...}, {@linkplain ...}, {@linkcode ...}, {@tutorial ...}. @abstract This member must be implemented (or overridden) by the inheritor. @access Specify the access level of this member - private, public, or protected. @alias Treat a member as if it had a different name. @augments This object adds onto a parent object. @author Identify the author of an item. @borrows This object uses something from another object. @callback Document a callback function. @classdesc Use the following text to describe the entire class. @constant Document an object as a constant. @constructor This function is intended to be called with the "new" keyword. @constructs This function member will be the constructor for the previous class. @copyright Document some copyright information. @default Document the default value. @deprecated Document that this is no longer the preferred way. @desc Describe a symbol. @enum Document a collection of related properties. @event Document an event. @example Provide an example of how to use a documented item. @exports Identify the member that is exported by a JavaScript module. @external Document an external class/namespace/module. @file Describe a file. @fires Describe the events this method may fire. @global Document a global object. @ignore [todo] Remove this from the final output. @inner Document an inner object. @instance Document an instance member. @kind What kind of symbol is this? @lends Document 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. @link Inline tag - create a link. @member Document a member. @memberof This symbol belongs to a parent symbol. @method Describe a method or function. @mixes This object mixes in all the members from another object. @mixin Document a mixin object. @module Document a JavaScript module. @name Document the name of an object. @namespace Document a namespace object. @param Document the parameter to a function. @private This symbol is meant to be private. @property Document a property of an object. @protected This member is meant to be protected. @public This symbol is meant to be public. @readonly This symbol is meant to be read-only. @requires This file requires a JavaScript module. @returns Document the return value of a function. @see Refer to some other documentation for more information. @since When was this feature added? @static Document a static member. @summary A shorter version of the full description. @this What does the 'this' keyword refer to here? @throws Describe what errors could be thrown. @todo Document tasks to be completed. @tutorial Insert a link to an included tutorial file. @type Document the type of an object. @typedef Document a custom type. @variation Distinguish different objects with the same name. @version Documents the version number of an item.
相关文章推荐
- js基础之DOM中document对象的常用属性方法
- 【linux学习】常用linux基础指令1
- JS基础之运动框架,能实现常用动画效果
- Vue.js的常用指令-vue.js
- linux 常用基础指令记录
- js中Date对象与Math对象常用基础知识
- 一些常用的基础Linux操作指令
- vue.js(2.0)常用指令总结以及一些指令的坑!
- JS中String对象与Array对象常用基础知识
- Ionic基础——js指令布局
- Vue.js基础指令实例讲解(各种数据绑定、表单渲染大总结)
- js常用正则表达式以及以下常用基础知识
- 【Vue.js】- Vue.js常用指令的使用
- Angular JS从入门基础 mvc三层架构 常用指令
- Vue.js常用指令汇总(v-if、v-for等)
- Linux中基础笔记(必备知识)包含常用指令以及tomcat搭建 系列1
- 常用指令 参考《鸟哥的Linux私房菜+基础学习篇 第三版》
- linux基础笔记一常用指令
- Linux基础整理-vi/vim常用指令与简单配置
- Vue.js常用指令汇总(v-if//v-show//v-else//v-for//v-bind//v-on等)