В настоящее время я переключаюсь с rdoc на ярд для своей документации по программному обеспечению Ruby.
В моем doc Я часто ссылаюсь на некоторые классы / модули в комментариях, например:
## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##
Rdoc правильно создает ссылку на Mysoft :: Mypackage :: Страница документации класса Utility :: Logger, а ярд игнорирует тег и рассматривает имя класса как простую строку.
Я знаю, что у ярда есть тег @see, однако это создаст отдельный раздел «См. Также» в документации, в то время как мне нужно сослаться на класс / модули в моем тексте описания.
Я определенно что-то упускаю, но если у вас есть какие-либо примеры того, как это должно быть сделано с ярдом, я был бы очень признателен.
Спасибо per advace,
dl