2012-02-21 5 views
0

Если я зарегистрирую код с помощью YARD и использую, например, тег @overload, а кто-то еще устанавливает мой драгоценный камень, и он создает документацию с помощью RDoc, не будет ли результат бесполезным?Совместимость с YARD и RDoc

Есть ли хороший способ справиться с этим?

+0

Не совместим ли это один из способов? То есть, YARD может читать RDoc, но не наоборот. И большинство людей переписывают YARD через RDoc. – sawa

+0

Да, это то, что я получаю. Но, видя, что люди там все еще могут использовать RDoc и не имеют YARD, как вы справляетесь с этим, когда используете теги, специфичные для YARD, для документирования вашего кода? – mydoghasworms

ответ

0

Is не поддерживает @overload, но TomDoc служит работоспособным. RDoc теперь поддерживает TomDoc из коробки, а у Yard есть плагин yard-tomdoc. YARD по-прежнему лучше (IMO) для крупных проектов, но для небольших библиотек или инструментов TomDoc работает хорошо и может использоваться обеими системами.

Смежные вопросы