Двор и ссылки на классы / модули в документе

Question

В настоящее время я переключаюсь с rdoc на ярд для моей документации по программному обеспечению ruby.

В моем документе я часто ссылаюсь на некоторые классы / модули из комментариев, например:

## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##

Rdoc правильно создает ссылку на страницу документации класса Mysoft::Mypackage::Utility::Logger, а ярд игнорирует тег и считает имя класса простой строкой.

Я знаю, что ярд имеет тег @see, однако это создаст отдельный раздел "См. Также" в документации, а мне нужно сослаться на класс / модули внутри моего описания.

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

Спасибо за продвижение,

дл

Answer 1

Quoth документация:

YARD поддерживает специальный синтаксис для ссылки на другие объекты кода или файлы. Синтаксис {ObjectName#method OPTIONAL_TITLE}, Этот синтаксис приемлем в любом месте документации, за исключением @see тег, который автоматически связывает свои данные.

Итак, вы хотите

## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##