-
Notifications
You must be signed in to change notification settings - Fork 1
Coding Style guide
George Sheppard edited this page Sep 30, 2020
·
5 revisions
I suggest that we follow this style guide:
https://github.com/basarat/typescript-book/blob/master/docs/styleguide/styleguide.md
In terms of function documentation, where possible use JSDoc conventions e.g.
/**
* Description
* @param nameOfParam Description of param
* @returns Description of return value
* @example Optional examples to better explain use case
*/
function Add(type annotations here so no need to label in the docstring) {}
With VSCode hovering a function imported from elsewhere will display this docstring and the function definition.