Приличный (авто)документатор проектов детектед - codo

31 views
Skip to first unread message

Дмитрий Карпич

unread,
Aug 14, 2012, 8:42:48 AM8/14/12
to coffees...@googlegroups.com
Нашел очень качественный авто-генератор документации API для кода написанного на CoffeScript.
Называется codo - https://github.com/netzpirat/codo.

Автор заявляет его как аналог YARD.

Вполне дельная штука, довольно удобный формат на выходе и активная поддержка со стороны автора.

На странице проекта есть ссылки на примеры.
Я для пробы сделал доку на dendrite - в полном варианте http://meettya.github.com/dendrite/doc/ , а вто так выглядит отдельная страница класса http://meettya.github.com/dendrite/doc/classes/Dendrite.html. Ага, для одномодульного проекта немного оверкильно, но лучше владеть универсальным инструментом, чем париться с переводом при разрастании.

Пишите доки с удовольствием :)

PS. CoffeeDoc с питонячьим синтаксисом что-то не пошел, а doco хорош только для функциональщины, ИМХО.

ilya

unread,
Aug 15, 2012, 12:00:33 AM8/15/12
to CoffeeScript2ru
да, выглядит красиво!

On Aug 14, 6:42 pm, Дмитрий Карпич <meet...@gmail.com> wrote:
> Нашел очень качественный авто-генератор документации API для кода
> написанного на CoffeScript.

> Называется codo -https://github.com/netzpirat/codo.


>
> Автор заявляет его как аналог YARD.
>
> Вполне дельная штука, довольно удобный формат на выходе и активная
> поддержка со стороны автора.
>
> На странице проекта есть ссылки на примеры.

> Я для пробы сделал доку на dendrite - в полном вариантеhttp://meettya.github.com/dendrite/doc/, а вто так выглядит отдельная
> страница классаhttp://meettya.github.com/dendrite/doc/classes/Dendrite.html. Ага, для

Reply all
Reply to author
Forward
0 new messages