From b2f15cf21ae7b08986468dd8d18b06f9c2e97dc2 Mon Sep 17 00:00:00 2001 From: Vincent LE GOFF Date: Fri, 15 Mar 2019 16:53:21 +0100 Subject: jsdoc style guide update (#1932) --- website/style_guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'website') diff --git a/website/style_guide.md b/website/style_guide.md index bb0a643ef..c2ed2c483 100644 --- a/website/style_guide.md +++ b/website/style_guide.md @@ -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: -- cgit v1.2.3