diff --git a/standards/documentation.md b/standards/documentation.md index ee5bbc0..3fca82b 100644 --- a/standards/documentation.md +++ b/standards/documentation.md @@ -128,8 +128,8 @@ A function/method documentation MUST be implemented in the following form: * * Optional example or more detailed description. * - * @param {variable_type} param1Name Parameter description - * @param {variable_type} [optionalPara] Parameter description + * @param {variable_type_1} param1Name Parameter description + * @param {variable_type} [optionalPara] Parameter description * * @return {return_type} * @@ -137,4 +137,6 @@ A function/method documentation MUST be implemented in the following form: */ ``` +Please also note the correct alignment of `@param` type, name and description + ### Variable