29

私は現在、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はタグを無視し、クラス名を単純な文字列と見なします。

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

私は確かに何かが欠けていますが、これがヤードでどのように行われるべきかについての例があれば、私は本当に感謝します。

前進ごとに感謝します、

dl

4

1 に答える 1

41

ドキュメントを引用します：

YARD は、他のコード オブジェクトまたはファイルにリンクするための特別な構文をサポートしています。構文は{ObjectName#method OPTIONAL_TITLE}. @seeこの構文は、データを自動的にリンクするタグを除いて、ドキュメントのどこでも使用できます。

あなたが望んでいるのは

## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##
于 2010-09-16T12:36:41.347 に答える