Создавайте связи между функциями / классами ESDoc и страницами справочника и наоборот.

Question

Я новичок в ESDoc, но у меня есть многолетний опыт работы с JSDoc.

Ближайшим эквивалентом функций учебников JSDoc является функция справочника ESDoc. Это позволяет вам написать отдельную документацию по уценке, которая будет включена в окончательную сборку документации.

У меня две проблемы:

1. В описании функции или класса, как я могу ссылаться на раздел в руководстве? В JSDoc тег @tutorial сделал это, но в ESDoc его нет, и, похоже, нет эквивалентного тега @manual.
2. На странице руководства, как я могу вернуться к документации для функции / класса? В JSDoc я мог использовать тег @link, но это не работает на страницах справки ESDoc.

Answer 1

Попробуйте использовать @see в соответствии с документами здесь