четверг, 18 апреля 2013 г.

Ruby: Gems и кое-что о документации

Сподобился таки оформить пару модулей как гемы и разместить на RubyGems.org:

  • is-command — DSL для написания «многокомандных» консольных приложений, т.е. таких, которые используются в виде:

    $ program ‹опции› ‹команда› ‹опции› ‹параметры›
    причем команды могут быть вложенные. Так, например, работает Git.

    На данный момент не сделана генерация справочного сообщения, посему версия 0.8, а не 0.9.

  • is-lazy — модуль для «ленивых» и многопоточных вычислений, о котором я уже писал (правда, изрядно реорганизованный).

На GitHub я поместил их в один проект — https://github.com/shikhalev/gems, куда и в дальнейшем планирую складывать всякую ruby-мелочевку.

В процессе выяснилась приятная вещь — если код документировать в комментариях посредством YARD, без каких-либо лишних телодвижений получаем онлайн-документацию на RubyDoc.info (см. [1] и [2]), на которую ведет ссылка со страницы гема. Документация появляется с некоторым запозданием порядка минут или часов, но это ж не страшно. Кроме того, с минимальными телодвижениями можно организовать такую же документацию для любого проекта на GitHub — нужно лишь включить соответствующий пункт в «Settings / Service Hooks» — см. [3].

Традиционное зеркало проекта на BitBucket — https://bitbucket.org/shikhalev/gems.

Комментариев нет:

Отправить комментарий