Как мы можем указать, что это поле является необязательным / мандатом в apidocjs?

Question

Мы работаем над expressJS и apidocJS, не в состоянии определить необязательные поля в таблице. Мы хотели бы обновить поля с мандатом или нет, чтобы пользователи могли определить требования к параметрам.

пример кода:

 * @apiParam {String} name The User Name.
 * @apiParam {String} email The Email Id.
 * @apiParam {String} password The Users High security Password.
 * @apiParam {String} privilegeRole The Users Privilege Role.

Answer 1

* @apiParam {String} [optional_field] This field is optional.
* @apiParam {String} required_field This is required.

Квадратная скобка в имени поля скажет, что это необязательно в apidoc

[поле] - Имя поля в скобках определяет переменную как необязательную.