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