Javascript 如何记录闭包
我试图在一个名为User的类中记录功能,该类位于闭包中——我如何使用JsDoc3实现这一点 以下是我所拥有的:Javascript 如何记录闭包,javascript,documentation,closures,jsdoc,Javascript,Documentation,Closures,Jsdoc,我试图在一个名为User的类中记录功能,该类位于闭包中——我如何使用JsDoc3实现这一点 以下是我所拥有的: /** @class User @classdesc This is the class that describes each user. */ (function($){ var _defaults = { 'first_name': '', 'last_name': '' }; /** @
/**
@class User
@classdesc This is the class that describes each user.
*/
(function($){
var _defaults = {
'first_name': '',
'last_name': ''
};
/**
@constructor
*/
function User(options) {
this.options = $.extend({}, _defaults, options);
}
/**
@method
@desc Returns the combined first name and last name as a string
@returns {string}
*/
User.prototype.getName() = function(){
return this.options.first_name + this.options.last_name;
};
window.User = User;
}(jQuery));
我不知道为什么jsdoc3决定忽略闭包中的文档,但至少有一种解决方法是使用
@memberOf
标记来明确说明方法属于哪个类:
/**
* @memberOf User
* Returns the combined first name and last name as a string
* @returns {string}
*/
User.prototype.getName = function(){
另一件需要注意的事情是,您不需要使用
@desc
和@classdesc
标记-这些标记是由jsduc3本身自动添加的,这些标记的存在更像是一个实现细节。我成功地使用了这种方法。(添加到样板插件,因此包含MIT许可评论)
请参阅原型上@global+@类和@global的用法。
似乎就是这样
代码复制如下:
请尽情享受,让它变得更好
/**
* jQuery lightweight plugin boilerplate
* Original author: @ajpiano
* Further changes, comments: @addyosmani
* Licensed under the MIT license
*/
;(function ( $, window, document, undefined ) {
var pluginName = "Application",
defaults = {
propertyName: "value"
};
/**
* @global
* @class Application
* @description MASTER: Sets up and controls the application
*
* @returns Object
*/
function Application( element, options ) {
this.element = element;
this.options = $.extend( {}, defaults, options) ;
this._defaults = defaults;
this._name = pluginName;
this.init();
window[pluginName] = this;
}
/** @global */
Application.prototype = {
/**
* @description call pre-life initialisations and tests here
*/
init: function() {
var that = this;
that._build();
that._setNotifications();
},
/**
@description Set up a pub sub for global notifications such a state-changes.
*/
_setNotifications: function(el, options) {
console.log('Application=>setNotifications()');
},
/**
@description All environment setup done we now call other plugins.
*/
_build: function(el, options) {
console.log('Application=>build()');
}
};
$.fn[pluginName] = function ( options ) {
return this.each(function () {
if (!$.data(this, "plugin_" + pluginName)) {
$.data(this, "plugin_" + pluginName,
new Application( this, options ));
}
});
};
})( jQuery, window, document );
在我的例子中,闭包位于单个文件中,并使用字典导出其对象,因此使用概述中的@file和@exports-DicName标记以及字典中的@namespace标记可以将它们记录下来
/**
@file myFileWithClosure
@exports DicName
*/
(function($){
/** @namespace */
DicName = {};
...
不需要全球合作