Question

我在我的项目上运行public class Dog : Animal { public override IEnumerable<ValidationResult> Validate(ValidationContext validationContext) { foreach(var result in base.Validate(validationContext).ToList()) { } //dog specific validation follows here... } }并且有一个文件（唯一有意义的文件），其中方法的顺序对于分组方法很重要。如何在生成的文档中使用与源文件中相同的函数顺序？

实际上，如果有帮助的话，我已准备好更改doc框架。

Answer 1

不幸的是，似乎没有办法告诉文档管理员列出方法的顺序。

但是，@see可能对您有用，可以引起对相关功能的注意。再加上关于所需订单的完整描述中的注释，或者某些无序例外可能是该工具目前可以提供的最佳例外。

Answer 2

检查以下网址，了解记录PHP程序的步骤，

http://pear.php.net/manual/en/package.php.phpdocumentor.intro.php

Answer 3

我认为无法申报特定订单。

可以构建@package s 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;
    }
}

除了分组功能外，您还应尝试通过语义和逻辑方式将大类拆分为较小的业务部分来改进编程。

在phpdoc中保存功能顺序

3 个答案: