Какой формат документации комментариев лучше для JavaScript?

Question

Есть ли какой-либо формат документации комментариев для JavaScript и процессор для этого формата, который генерирует документацию HTML?

В настоящее время я использую комментарии VSDoc xml для предоставления помощи IntelliSense во время разработки, но, как я знаю, нетГенератор документации для таких комментариев.Поэтому в качестве альтернативы мой вопрос может звучать так: существует ли какая-либо утилита, которая переводит комментарии VSDoc из файлов JavaScript в HTML?

Answer 1

Вы просматривали автоматически сгенерированную документацию из JavaDoc, VSDoc, JSDoc или чего-то подобного.

Все они некрасивые и не читаемые.

Решение в два раза

• аннотировать ваш код с помощью Docco
• Сделайте свою документацию по API написанной от руки.

Существует третий вариант, который должен революционизировать способ, которым мы создаем автоматически сгенерированную документацию, если вы можете, пожалуйста, сделайте.

Answer 2

Существует утилита, которая анализирует файлы Javascript и выводит тот же формат XML, который используют NDoc и Sandcastle: AjaxDoc

Таким образом, вы получаете VS Intellisense из тех же комментариев и можете выводить любой формат, который вы хотите.

Answer 3

Я использовал Natural Docs для нескольких проектов.Синтаксис удобен для чтения inline, но, поскольку он не имеет «полной языковой поддержки» для JavaScript, вы должны быть несколько ясны в отношении каждой функции / константы / класса / того, что вы хотите документировать.