Last active
December 21, 2015 08:59
-
-
Save Kuniwak/6282048 to your computer and use it in GitHub Desktop.
Jsdoc3でjQueryプラグインをアノテーションする。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(function($) { | |
/** | |
* @constructor | |
* @alias Foo | |
*/ | |
var Foo = function() { | |
}; | |
/** | |
* Description. | |
*/ | |
Foo.prototype.foo = function() { | |
// ... | |
}; | |
/** | |
* @constructor | |
* @alias Bar | |
*/ | |
var Bar = function() { | |
}; | |
/** | |
* Description. | |
*/ | |
Bar.prototype.bar = function() { | |
// ... | |
}; | |
})(jQuery); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@alias
がポイント。これを書くとグローバルオブジェクトがエイリアスとして張られるので、うまくドキュメンテーションされる。