Комментарии 4
Обратите внимание еще на docular. Неплохая штука.
Чем JSDuck отличается от JSDoc?
Насколько они совместимы? Т.е. написав документацию на JSDuck, смогу ли я воспользоваться утилитами понимающими JSDoc?
Насколько они совместимы? Т.е. написав документацию на JSDuck, смогу ли я воспользоваться утилитами понимающими JSDoc?
Они обратно совместимы, но с учетом того, что есть различия по некоторым метатегам.
JSDuck более совместим с JSDoc, так как он появился позже и разрабатывался с учетом поддержки существующей документации. Смотрите документацию по метатегам на этот счет.
В любом случае, если метатеги будут несовместимые, то они просто проигнорируются генератором.
JSDuck более совместим с JSDoc, так как он появился позже и разрабатывался с учетом поддержки существующей документации. Смотрите документацию по метатегам на этот счет.
В любом случае, если метатеги будут несовместимые, то они просто проигнорируются генератором.
Доброго дня. Можно несколько вопросов?
* можно ли формировать одну страницу из нескольких мест? скажем в некую обзорную статью, где по каждому классу содержится вводное описание — из каждого класса накидать по абзацу текста с вводным описанием класса. но так, чтт бы этот абзац был в исходнике самого класса, что бы его можно было «править сразу на месте» при модификации класса?
* есть ли возможность группировать методы класса и определять порядок их следования в документации? скажем у сложного класса есть несколько методов, схожих по задачам, но с разным именем. я хочу что бы их описания были рядом, желательно в одном подзаголовке, а не по алфавитному порядку. потому что я зочу помось разработчику решать задачи, а не наслаждаться листанием списка методов… ну… по мне так было бы хорошо. я бы читал такую доку с бОльшим удовольствием.
* что с поддержкой многоязычности? я могу формировать документацию на нескольких языках?
* можно ли организовать несколько деревьев категорий и включать каждую статью в несколько ветвей разных категорий — скажем так, как это организованы статьи в MediaWiki? например для того, что бы в сложном наборе классов можно было рассортировать классы по различным вариантам иерархии, для облегчения навигации при ознакомлении?
* в оффлайне эта автодокументация работать будет? при просмотре стартовой html-страницы с диска? (я не в курсе деталей используемого js-фреймворка).
* как вставлять цитирование кода? т.е. примеры кода так, что бы парсер автодака не ломался в середине цитаты?
Понимаю, что эти запросы могут показаться не совсем типичными… Но мне именно этого не хватает от инструментов, которые я сейчас использую.
Спасибо.
* можно ли формировать одну страницу из нескольких мест? скажем в некую обзорную статью, где по каждому классу содержится вводное описание — из каждого класса накидать по абзацу текста с вводным описанием класса. но так, чтт бы этот абзац был в исходнике самого класса, что бы его можно было «править сразу на месте» при модификации класса?
* есть ли возможность группировать методы класса и определять порядок их следования в документации? скажем у сложного класса есть несколько методов, схожих по задачам, но с разным именем. я хочу что бы их описания были рядом, желательно в одном подзаголовке, а не по алфавитному порядку. потому что я зочу помось разработчику решать задачи, а не наслаждаться листанием списка методов… ну… по мне так было бы хорошо. я бы читал такую доку с бОльшим удовольствием.
* что с поддержкой многоязычности? я могу формировать документацию на нескольких языках?
* можно ли организовать несколько деревьев категорий и включать каждую статью в несколько ветвей разных категорий — скажем так, как это организованы статьи в MediaWiki? например для того, что бы в сложном наборе классов можно было рассортировать классы по различным вариантам иерархии, для облегчения навигации при ознакомлении?
* в оффлайне эта автодокументация работать будет? при просмотре стартовой html-страницы с диска? (я не в курсе деталей используемого js-фреймворка).
* как вставлять цитирование кода? т.е. примеры кода так, что бы парсер автодака не ломался в середине цитаты?
Понимаю, что эти запросы могут показаться не совсем типичными… Но мне именно этого не хватает от инструментов, которые я сейчас использую.
Спасибо.
Зарегистрируйтесь на Хабре, чтобы оставить комментарий
JSDuck — генератор документации