Skip to content

Instantly share code, notes, and snippets.

@Kuniwak
Last active Dec 21, 2015
Embed
What would you like to do?
Jsdoc3でjQueryプラグインをアノテーションする。
(function($) {
/**
* @constructor
* @alias Foo
*/
var Foo = function() {
};
/**
* Description.
*/
Foo.prototype.foo = function() {
// ...
};
/**
* @constructor
* @alias Bar
*/
var Bar = function() {
};
/**
* Description.
*/
Bar.prototype.bar = function() {
// ...
};
})(jQuery);
@Kuniwak
Copy link
Author

Kuniwak commented Aug 20, 2013

@alias がポイント。

これを書くとグローバルオブジェクトがエイリアスとして張られるので、うまくドキュメンテーションされる。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment