将代码示例添加到PHP文档标记的正确方法是什么?

时间:2016-10-14 06:15:27

标签: php phpdoc phpdocumentor2

phpDocumentor(https://phpdoc.org)没有指定内联代码示例格式的正确方式。我以前见过:

Doxygen的:

/**
 * 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有@example@source但这些只是指向其他文件中行号的指针。内联代码片段更易于编写和理解。

0 个答案:

没有答案