Created
December 14, 2018 16:28
-
-
Save pinkhominid/d8ca54bc86daaabe5d3f172f3b6ea0d7 to your computer and use it in GitHub Desktop.
Good JSDoc Example (from https://github.com/rollup/rollup-starter-app)
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
/** | |
* @category Common Helpers | |
* @summary Convert the given argument to an instance of Date. | |
* | |
* @description | |
* Convert the given argument to an instance of Date. | |
* | |
* If the argument is an instance of Date, the function returns its clone. | |
* | |
* If the argument is a number, it is treated as a timestamp. | |
* | |
* If an argument is a string, the function tries to parse it. | |
* Function accepts complete ISO 8601 formats as well as partial implementations. | |
* ISO 8601: http://en.wikipedia.org/wiki/ISO_8601 | |
* | |
* If all above fails, the function passes the given argument to Date constructor. | |
* | |
* @param {Date|String|Number} argument - the value to convert | |
* @param {Object} [options] - the object with options | |
* @param {0 | 1 | 2} [options.additionalDigits=2] - the additional number of digits in the extended year format | |
* @returns {Date} the parsed date in the local time zone | |
* | |
* @example | |
* // Convert string '2014-02-11T11:30:30' to date: | |
* var result = parse('2014-02-11T11:30:30') | |
* //=> Tue Feb 11 2014 11:30:30 | |
* | |
* @example | |
* // Parse string '+02014101', | |
* // if the additional number of digits in the extended year format is 1: | |
* var result = parse('+02014101', {additionalDigits: 1}) | |
* //=> Fri Apr 11 2014 00:00:00 | |
*/ | |
function parse (argument, dirtyOptions) { | |
// Some code here | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment