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

Question

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

Единственное, что может беспокоить, это то, что это ПРОТИВ-Док.

Существуют ли конкурирующие форматы, которые являются нейтральными поставщиками?

И насколько широко стандарт VSDOC используется не-микрософт IDE, такими как Eclipse и т. Д.?

Answer 1

Стандарт, который используется больше всего, это JSDOC, как реализовано jsdoc-toolkit. Анкет Синтаксис короткий и краткий, и его легко проанализировать.

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

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