在phpdoc中保存函数顺序
在phpdoc中保存函数顺序
提问于 2015-06-19 17:08:48
我在我的项目上运行phpdoc，有一个文件(唯一有意义的文件)，其中方法的顺序对于分组方法很重要。如何才能在生成的文档中具有与源文件中相同的函数顺序？
实际上，如果有帮助的话，我已经准备好改变文档框架了。
回答 3
Stack Overflow用户
发布于 2015-06-30 04:59:27
不幸的是，似乎没有一种方法可以告诉文档员列出方法的顺序。
但是，@see可能有助于您引起对相关函数的注意。再加上完整描述中关于所需订单的注释，或者一些无序的例外可能是该工具目前所能提供的最好的。
Stack Overflow用户
发布于 2015-06-30 04:47:43
查看下面的url以获取记录PHP程序的步骤，
http://pear.php.net/manual/en/package.php.phpdocumentor.intro.php
Stack Overflow用户
发布于 2015-06-24 06:26:41
我认为不可能宣布一个具体的订单。
可以构建@package的tho，它用于PHP中的名称空间(afaik..)。
如果已声明了@package，则可以定义@subpackage来对方法/函数进行分组。
<?php
namespace Stackexchange\Stackoverflow;
/**
* My Answer
* @package Stackexchange\Stackoverflow
* @see http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html
*/
class Answer
{
/**
* @subpackage SomeSubGroup
* @return $this
*/
public function doSomething {
return $this;
}
/**
* @subpackage SomeOtherSubGroup
* @return $this
*/
public function doSomethingDifferent {
return $this;
}
}除了分组功能之外，您还应该尝试通过在语义上和逻辑上将大类划分为较小的业务部分来改进您的编程。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/30934210
复制相关文章
相似问题