Создавайте связи между функциями / классами ESDoc и страницами справочника, и наоборот - PullRequest
0 голосов
/ 04 июля 2018

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

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

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

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

1 Ответ

0 голосов
/ 03 июля 2019

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

...