В настоящее время я перехожу от rdoc к двору для своей рубиновой программной документации.
В моем документе я часто ссылаюсь на некоторые классы/модули из комментариев, например:
## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##
Rdoc правильно создает ссылку на страницу документации класса Mysoft:: Mypackage:: Utility:: Logger, а ярд игнорирует тег и считает имя класса простой строкой.
Я знаю, что у ярда есть тег @see, но это создаст отдельный раздел "См. также" в документации, в то время как мне нужно ссылаться на класс/модули внутри моего текста описания.
Я, конечно, что-то пропустил, но если у вас есть примеры того, как это сделать со мной, я бы очень оценил.
Спасибо за advace,
дл
Quoth документация:
YARD поддерживает специальный синтаксис для связи с другими объектами или файлами кода. Синтаксис
{ObjectName#method OPTIONAL_TITLE}. Этот синтаксис допустим в любом месте документации, за исключением тега@see, который автоматически связывает его данные.
Итак, вы хотите
## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##