2

phpDocumentor ( https://phpdoc.org ) は、インライン コード サンプルをフォーマットする正しい方法を指定していません。私は以前に見たことがあります:

ドキシゲン:

/**
 * Set a variable like:
 *
 * \code
 * $foo = 'bar';
 * \endcode
 */

ゴースタイル:

/**
 * Set a variable like:
 *
 *     $foo = 'bar';
 */

Java スタイル:

/**
 * Set a variable like:
 *
 * <pre><code>
 * $foo = 'bar';
 * </code></pre>
 */

Python スタイル:

/**
 * Set a variable like:
 *
 * >>> $foo = 'bar';
 */

phpDocumentor には@exampleand@sourceがあることは理解していますが、これらは他のファイルの行番号への単なるポインターです。インライン コード スニペットは、記述と理解がはるかに簡単です。

4

0 に答える 0