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

Question

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

Answer 1

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

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

Пример настраиваемого тега:

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

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

customTaggedFunction()

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

Вид: глобальная функция
Создано в: Нигерия