Альтернатива VSDoc? - PullRequest
       18

Альтернатива VSDoc?

1 голос
/ 07 июня 2010

VSDoc - это отличный способ комментировать Javascript, и мне особенно нравится возможность «зависеть» от одного файла Javascript от другого.Это прокладывает путь для минимизаторов / объединителей Javascript, которые учитывают правильное упорядочение сценариев.

Единственное, что может беспокоить некоторых, это то, что это VS -Doc.

Существуют ли какие-либо конкурирующие форматы, не зависящие от производителя?

И насколько широко стандарт VSDoc используется в таких средах разработки сторонних разработчиков, таких как Eclipse и т. Д.?

1 Ответ

3 голосов
/ 07 июня 2010

Чаще всего используется стандарт JsDoc, реализованный с помощью jsdoc-toolkit . Синтаксис короткий и лаконичный, его легко разобрать.

Есть много инструментов, которые могут генерировать документацию из них, таких как ext-doc , и большинство IDE имеют встроенную поддержку для этого.

Здесь нет никаких операторов для аннотирования зависимостей, но это на самом деле скорее проблема минификатора, чем проблема документации, поскольку любой комментарий может включать список зависимостей.

...