Ограничения документа в JSDoc

Question

У меня есть функция, которая является компонентом React. Элемент, который он создает, имеет position:absolute; Чтобы это свойство работало предсказуемым образом, родительский элемент должен располагаться с position: relatieve;. Я хотел бы, чтобы будущие пользователи этого компонента знали об этом ограничении. Есть ли для этой цели тег JSDo c? Как бы вы сообщили пользователям этого компонента об этом важном ограничении?

Answer 1

Вы должны подчеркнуть, что ваш компонент во время выполнения зависит от определенного внешнего состояния. Для этого нет никакого специального тега c jsdo c, вам нужно документировать его в описании.

В jsdoc2md вы можете объявить любой произвольный тег, если это поможет - вы можете придумать свой собственный тег для его документирования.

Пример пользовательского тега:

/**
 * This function has a wonderful custom tag
 * @createdIn Nigeria
 */
function customTaggedFunction () {}

Производит это вывод:

customTaggedFunction ()

Эта функция имеет замечательный пользовательский тег

Kind : глобальная функция
Createdin : Нигерия