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

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

Квот Документация :

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

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

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