foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00
Code Issues Packages 1 Wiki Activity

jsdoc style guide update (#1932)

Browse source
This commit is contained in:
Vincent LE GOFF 2019-03-15 16:53:21 +01:00 committed by Ryan Dahl
parent 4dbc33c6e3
commit b2f15cf21a
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
website/style_guide.md
View file

@ -230,7 +230,15 @@ For example:
Do not document function arguments unless they are non-obvious of their intent
(though if they are non-obvious intent, the API should be considered anyways).
Therefore `@param` should generally not be used.
Therefore `@param` should generally not be used. If `@param` is used, it should
not include the `type` as Typescript is already strongly typed.
```ts
/**
* Function with non obvious param
* @param foo Description of non obvious parameter
*/
```
Vertical spacing should be minimized whenever possible. Therefore single line
comments should be written as: