Сохранить порядок функций в phpdoc

Я запускаю phpdoc в моем проекте и там файл (единственный значащий файл), в котором порядок методов важен для методов группировки. Как я могу иметь тот же порядок функций в сгенерированной документации, что и в исходном файле?

На самом деле, я готов изменить структуру документа, если это поможет.

Ответ 1

К сожалению, похоже, что есть способ рассказать документу о том, какой порядок перечислить методы.

Однако @see может оказаться полезным для вас привлечь внимание к связанным функциям. Это в сочетании с примечанием в полном описании о требуемом заказе или некоторыми исключениями из порядка может быть лучшим, что может предложить данный инструмент.

Ответ 2

проверьте приведенный ниже URL для шагов по документированию программы PHP,

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

Ответ 3

Я думаю, что невозможно объявить конкретный порядок.

Можно построить @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;
    }
}

Помимо функции группировки, вы должны попытаться улучшить вашу программирование семантически и логически разделяя большие классы на более мелкие бизнес-части.