sublime - phpdoc template

Guardar orden de funciones en phpdoc

Question

Estoy ejecutando phpdoc en mi proyecto y hay un archivo (el único archivo significativo), en el que el orden de los métodos es importante para agrupar los métodos. ¿Cómo puedo tener el mismo orden de funciones en la documentación generada que en el archivo de origen?

En realidad, estoy listo para cambiar el marco doc, si ayuda.

Answer 1

Creo que no es posible declarar una orden específica.

Es posible compilar @package s tho, que está diseñado para espacios de nombres en PHP (afaik ..).

Si ha declarado un @package , puede definir @subpackage s para agrupar métodos / funciones.

<?php
namespace Stackexchange/;
/**
 * My Answer
 * @package Stackexchange/
 * @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;
    }
}

Además de la función de agrupación, debe tratar de mejorar su programación dividiendo las clases grandes de forma semántica y lógica en partes de negocios más pequeñas.

Answer 2

Desafortunadamente, no parece que haya una manera de decirle al documentador en qué orden debe listar los métodos.

Sin embargo, @see puede serle útil para llamar la atención sobre las funciones relacionadas. Eso, junto con una nota en la descripción completa sobre el pedido que se necesita, o algunas excepciones fuera de orden puede ser lo mejor que la herramienta puede ofrecer actualmente.

Answer 3

revise la siguiente url para ver los pasos para documentar un programa PHP,

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