Sto eseguendo phpdoc sul mio progetto e c'è un file (l'unico file significativo), in cui l'ordine dei metodi è importante per i metodi di raggruppamento. Come posso avere lo stesso ordine di funzioni nella documentazione generata come nel file sorgente?Salvare le funzioni in phpdoc
In realtà, sono pronto a modificare il framework doc, se è utile.
Penso che non sia possibile dichiarare un ordine specifico.
È possibile creare @package s tho, che è pensato per gli spazi dei nomi in PHP (afaik ..).
Se è stato dichiarato @package, è possibile definire s per raggruppare metodi/funzioni.
<?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;
}
}
Oltre alla funzione di raggruppamento, si dovrebbe cercare di migliorare la programmazione da semanticamente e logicamente dividere grandi classi in più piccole, parti di business.
Ci sono validi motivi per voler mantenere l'ordine delle funzioni che non ha nulla a che fare con le pratiche OO scadenti. Soprattutto nella documentazione. – Cypher
Sfortunatamente, i requisiti del progetto mi inducono a utilizzare lo stile semplice di OOP. –
controllo l'url seguito per la procedura di documentare un programma PHP,
http://pear.php.net/manual/en/package.php.phpdocumentor.intro.php
Questo non risponde alla domanda specifica, ma è un buon riferimento. Ha taggato la domanda con 'phpdoc' e lo menziona, quindi presumo che conosca l'idea generale. – ToothlessRebel
Purtroppo, non risulta ci sia un modo per dire al documentatore quale ordine di elencare metodi.
Tuttavia, @see può essere utile per attirare l'attenzione sulle funzioni correlate. Ciò è accompagnato da una nota nella descrizione completa sull'ordine che è necessario, oppure alcune eccezioni fuori ordine potrebbero essere le migliori che lo strumento possa offrire attualmente.
Mi piace la tua risposta e la assegnerò con taglie se non vengono fornite risposte migliori. –
Anche se questa non è una cattiva domanda, dover fare affidamento sull'ordine di funzioni/metodi è una cattiva pratica (almeno in PHP). – DanFromGermany
@DanFromGermany: Sì, ma forse dal punto di vista della documentazione si desidera raggruppare le funzioni correlate. Un po 'come php.net dove le funzioni degli array non sono mescolate con le funzioni PDO ecc ... – AbraCadaver
Se hai diversi gruppi di funzioni all'interno di una singola classe php/file - ti suggerisco di dividerli in classi diverse/spazi dei nomi –