2015-06-19 37 views
16

我跑我的项目phpdoc,有一个文件(唯一有意义的文件),其中的方法的顺序是分组方法很重要。如何在生成的文档中使用与源文件中相同的函数顺序?保存功能订购PHPDoc的

其实,我已经准备好改变DOC框架下,如果有帮助。

+1

虽然这不是一个坏的问题,不必依赖的函数/方法的顺序是不好的做法(至少在PHP)。 – DanFromGermany

+2

@DanFromGermany:是的,但从文档的角度来看,您希望将相关功能组合在一起。有点像php.net,其中数组函数没有与PDO函数混合在一起... – AbraCadaver

+2

如果你在单个PHP类/文件内部有几组函数 - 我建议你将它们分成不同的类/名称空间 –

回答

-2

我认为不可能声明特定的顺序。

这是不可能建立@package小号寿,这是在PHP意味着命名空间(据我所知..)。

如果你已经声明了一个@package,你可以定义@subpackage s到组方法/函数。

<?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; 
    } 
} 

除了分组功能,你应该尝试通过语义和逻辑分割大类成更小,商业部分,以提高你的编程。

+0

想要保持功能顺序与OO的不良做法无关,这是有道理的。特别是在文档中。 – Cypher

+0

不幸的是,该项目的要求使我使用OOP的简洁风格。 –

3

不幸的是,它不会出现有一种方法来告诉记录器什么顺序列出的方法。

但是,@see可能会有助于您提请注意相关功能。加上关于所需订单的完整描述中的说明,或者一些不按规定的例外可能是该工具当前可以提供的最佳方式。

+0

我喜欢你的答案,如果没有更好的答案,我会奖励奖励。 –