Как обработать файл README с RDOC для отображения справки / использования сценариев Ruby

Question

Я хотел бы сохранить свое использование документацию в файле Readme (DUH) вместо комментариев в верхней части моего сценария. Как получить RDOC :: Использование, чтобы вытащить информацию об использовании из readme вместо комментариев сценария?

Answer 1

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

Вместо этого вы можете посмотреть Площадка, который на основе тегов. Могу ли я получить мой readme.textile в мой RDOC с правильным форматированием? Имеет некоторую полезную информацию для вас тоже.

В любом случае, если вы не можете получить приложение для анализа Doc Readme типа, как вы хотите, вы сможете поднять его, поместив все свои документы в файл вместе с классом и методом заглушки, поэтому синтаксические парики могут захватить Параметры, глобалы и другие «othnnot» им нужно создать полезную документацию.

В противном случае вам, вероятно, придется forgo, используя автоматическую помощь и введите его все.

Моя рекомендация состоит в том, чтобы сделать это RDOC Way, а документ внутри вашего кода. Не сложно делать вообще, и вывод может быть очень удовлетворительным. Это довольно удивительно, насколько хороша работа RDOC может сделать.

Answer 2

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

Большинство разработчиков вряд ли когда-либо обновляют документацию, даже если это 3 строки кода выше реализации.

Сделайте одолжение и не делайте процесс еще сложнее.

Обеспечение общей документации отдельно - это хорошая идея, но в любом случае не имеет ничего общего в вашем выходе RDOC.