Created
January 8, 2013 15:55
-
-
Save Macagare/4484888 to your computer and use it in GitHub Desktop.
JS: method documentation
This file contains hidden or 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
/** | |
* This is a method declaration; and the | |
* explanatory text is followed by a newline. | |
* | |
* @param {String} param1 Parameter name | |
* @param {String} param2 (Optional) Optional parameter | |
* @return {Boolean} Return value | |
*/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment