是否可以在Sami生成的api文档中添加换行符

时间:2017-10-10 21:36:38

标签: php phpdoc

TL; DR :如何强制让Sami呈现换行?

我正在使用Sami文档生成器生成文档。我有一个方法评论如下:

/**
 * This method gets called by the Dispatcher's Event manager.
 * This component was added as a dispatch listener in bootstrap.php.
 *
 * @return  boolean TRUE if the current user is allowed to access the current action
 *                  FALSE if the current user is not allowed to access the current action, 
 *                  or if the action doesn't have an ACL entry
 */

前两行在文档中以不同的方式呈现 - 很棒。

返回值的说明显示在1行。我可以将<br />放在第一行的末尾,但我认为在PHP注释中看起来很糟糕。萨米似乎认识到Markdown斜体和粗体,但不能识别双线空间的换行符。

是否有其他方法可以强制换行?

0 个答案:

没有答案