Skip to content

Instantly share code, notes, and snippets.

@Macagare
Created January 8, 2013 15:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Macagare/4484888 to your computer and use it in GitHub Desktop.
Save Macagare/4484888 to your computer and use it in GitHub Desktop.
JS: method documentation
/**
* 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