Docco-подобный инструмент, который вмещает комментарии в стиле JSDoc?

Я рассматриваю использование документации docco для JavaScript, но многие из моих существующих кодовых баз используют комментарии стиля JSDoc. Есть ли другой инструмент документации - или вилка Docco - который анализирует типичный стиль и комментарии в стиле JSDoc?

Ответы

Ответ 2

Docker - еще одна приятная версия docco, которая добавляет некоторую базовую поддержку JSDoc.

Ответ 3

JSDoc и Docco используют радикально разные подходы к документации:

  • один документ передает интерфейс, другой предназначен для документирования реализации.
  • один довольно жесткий и структурированный, другой - как свободный, как может быть.

Я действительно не понимаю, как вы думаете, что оба подхода должны быть объединены.

Но так или иначе... Docco анализирует только однострочные комментарии, а JSDoc-нравится в основном просто анализировать блок-комментарии формы /** ... */. Поэтому, по крайней мере, теоретически вы должны иметь возможность запускать как Docco, так и JSDoc по одному и тому же файлу - каждый инструмент смотрит на свои комментарии.

Ответ 4

Docco-husky - это то, что вы ищете. Он поддерживает JSDoc, а также некоторые другие аккуратные расширения, такие как рекурсивные каталоги.

Ответ 5

Мне также понадобилось нечто подобное, поэтому я собрал это: https://github.com/tnyuan/docco. Не уверен, что это помогает.