Javadoc на CoffeeScript?

Я новичок в CoffeeScript и кажется, что не могу найти генератор документов для CoffeeScript с использованием синтаксиса Javadoc. Единственный, который я мог найти, доступен как патч для компилятора CoffeeScript.

Итак, что вы используете для создания документации из комментария Javadoc на CoffeeScript или как вы документируете аргументы функции и возвращаете значения?

Ответы

Ответ 1

Таким образом, синтаксис JavaDoc никогда не встречался с разработчиками JavaScript. Есть те, кто использует что-то вроде этого - особенно Google, - но это немного противоречит JS, который не имеет статической типизации и позволяет любое количество аргументов для любой функции.

Если вы хотите создать красивую документацию с CoffeeScript, стандарт Docco (его домашняя страница - отличный пример). Если вы хотите создавать комментарии в стиле JavaDoc для каждой функции... ну, вам придется создавать их вручную и избегать их с обратными окнами.

В качестве альтернативы вы можете работать в CoffeeScript, пока ваш код не будет готов к выпуску, а затем документируйте полученный JavaScript.

Ответ 2

Docco отлично подходит для стиля прозелурального кодирования. Если вы хотите документировать API, coffeedoc для вас.

Ответ 3

Люди, ожидающие использования документации стиля javadoc в coffeescript, могут проверить кодо (http://netzpirat.github.com/codo/), которая обеспечивает поддержку подмножества javadoc и автоматически передает имена классов, функцию имена и параметры из исходного кода.

Ответ 4

Я использую YUIDoc. Я могу добавлять комментарии, используя синтаксис, подобный Javadoc, для моих классов, методов и событий. Документация выводится как файлы html/css, и вы даже можете настроить макет страницы.

Проверьте этот пример документации: http://yui.github.com/yuidoc/api/

PS: он полагается на Node.JS, и вам нужно установить пакет yuidocjs

npm install yuidocjs -g