Есть ли какой-либо формат документации комментариев для JavaScript и процессор для этого формата, который генерирует документацию HTML?
В настоящее время я использую комментарии VSDoc xml для предоставления помощи IntelliSense во время разработки, но, насколько я знаю, для таких комментариев нет генератора документации. В качестве альтернативы мой вопрос может звучать так: существует ли какая-либо утилита, которая переводит комментарии VSDoc из файлов JavaScript в HTML?
Вы смотрели на автоматически сгенерированную документацию из JavaDoc или VSDoc или JSDoc или что-то в этом роде.
Все они некрасивые и нечитаемые.
Решение в два раза
Есть и третий вариант, который состоит в том, чтобы коренным образом изменить то, как мы автоматически генерируем документацию. Если вы можете, пожалуйста, сделайте это.
Я использовал Natural Docs для нескольких проектов. Синтаксис удобен для чтения встроенного кода, но, поскольку он не имеет «полной языковой поддержки» для JavaScript, вы должны быть несколько явными в отношении каждой функции/константы/класса/всего, что вы хотите задокументировать.
Существует утилита, которая анализирует файлы Javascript и выводит тот же XML-формат, который используют NDoc и Sandcastle: AjaxDoc.
Таким образом, вы получаете интеллект VS из тех же комментариев и можете выводить любой формат, который хотите.
