php - 行番号のない PHPDOC の例

Question

PHPDocumentor のドキュメントによると、例を示すには次のようになります。

@example [location] [<start-line> [<number-of-lines>] ] [<description>]

コードが変更されない場合、これは有効なソリューションのように思えますが、場所がどこであっても新しいコードを追加するたびに、スタートラインが変更される可能性があるため、これらのさまざまな参照を常に更新する必要があります。

外部の現在の使用例を参照せずに、DocBlock 内でクラスメソッドを使用する方法の例を示すより良い方法はありますか?

ここに私が目指しているものがあります：

/**
 * @example This is how you use this method:
 *
 *     $baz = Foo::bar( array('bing' => $bing) ); 
 */

そして、例としてドキュメントに表示されます。何か案は？

score 1 · Accepted Answer

「code」区切り文字を使用して、docblock 自体にコード例を表示できます。したがって、元の例では：

/**
 * This is how you use this method:
 * <code>
 *     $baz = Foo::bar( array('bing' => $bing) ); 
 * </code>
 */

@example タグのマニュアルページ [1] には、docblock 内の「コード」セクションと、別のファイル内の行への @example ポインターの両方が示されています。

1 に答える 1