ヤードとドキュメント内のクラス/モジュールへのリンク

Question

現在、RubyソフトウェアのドキュメンのためにRDOCからYardに切り替えています。

私のドキュメントでは、たとえばコメントからいくつかのクラス/モジュールをよく参照することがよくあります。

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

RDOCは、MySoftへのリンクを正しく作成します:: myPackage :: utility :: loggerクラスドキュメントページ、ヤードはタグを無視し、クラス名を単純な文字列と見なします。

Yardには@Seeタグがあることは知っていますが、これはドキュメントに個別の「参照」セクションを作成しますが、説明テキスト内のクラス/モジュールを参照する必要があります。

私は確かに何かを見逃していますが、これが庭でどのように行われるべきかについての例があるなら、本当に感謝しています。

Advaceに感謝します、

DL

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
##