@@ -59,8 +59,16 @@
|
59 | 59 | * References to constructor instances should use camelCase. |
60 | 60 | * References to methods should be used with parentheses: for example, |
61 | 61 | `socket.end()` instead of `socket.end`. |
| 62 | +* Function arguments or object properties should use the following format: |
| 63 | +* <code>* \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`</code> |
| 64 | +* E.g. <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`</code> |
| 65 | +* The `type` should refer to a Node.js type or a [JavaScript type][] |
| 66 | +* Function returns should use the following format: |
| 67 | +* <code>* Returns: {type|type2} Optional description.</code> |
| 68 | +* E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code> |
62 | 69 | |
63 | | -[plugin]: http://editorconfig.org/#download |
64 | | -[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma |
65 | 70 | [Em dashes]: https://en.wikipedia.org/wiki/Dash#Em_dash |
| 71 | +[Javascript type]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#Data_structures_and_types |
| 72 | +[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma |
66 | 73 | [The New York Times Manual of Style and Usage]: https://en.wikipedia.org/wiki/The_New_York_Times_Manual_of_Style_and_Usage |
| 74 | +[plugin]: http://editorconfig.org/#download |