Javadoc на CoffeeScript?

Question

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

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

Answer 1

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

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

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

Answer 2

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

Answer 3

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

Answer 4

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

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

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

npm install yuidocjs -g