Articles of phpdoc

Php con NetBeans: Applicazione di nuovi PhpDoc senza la dichiarazione effettiva

C'è un modo per applicare nuovi PhpDoc senza ridichiarazione del metodo, ad esempio ho una class che: class GeneralContainer { private $children; public function __construct() { $this->children = $this->CreateChildren(); } protected function CreateChildren() { return new GeneralChildren($this); } /** * @return GeneralChildren */ public function Children() { return $this->children; } } Dopo aver ignorato il […]

PHPStorm e methods magici

Sto usando PHPStorm e ho scritto una class che utilizza la class SimpleXML. Tutto va bene, tranne quando attraverso una string XML otterrò avvertimenti "Proprietà indefinite". $xml = simplexml_load_string($string); //Returns SimpleXML Element echo $xml->childElement; //PHPStorm reports "Undefined Property Credo che questo sia dovuto al fatto che le properties; magiche non sono definite correttamente in PHPStorm. […]

PHPDoc: Typehint in matrici annidate (con es. 2 size)

Esiste un modo corretto per documentare valori / oggetti negli arrays che si trovano all'interno di un'altra dimensione? Normalmente un arrays verrà gestito in questo modo: /** @var ClassName[] $Array */ $Array = arrays( $InstanceOfClassName,.. ) Ma ho bisogno di qualcosa del genere: /** @var ClassName[][] $Array */ $Array = arrays( 0 => arrays( $InstanceOfClassName,.. […]

Come documentare un metodo accessor / mutator in phpDoc / javaDoc?

Data una function che si comport come un mutatore o un accessorio in base agli argomenti passati, come questo: // in PHP, you can pass any number of arguments to a function… function cache($cacheName) { $arguments = func_get_args(); if (count($arguments) >= 2) { // two arguments passed. MUTATOR. $value = $arguments[1]; // use the second […]

Come posso creare una documentazione di codice automatica per un progetto PHP?

Ho un grande progetto, che usa CakePHP. Ora vorrei creare una documentazione per altri nuovi colleghi di lavoro. Un'idea era di usare i commenti PHPdoc esistenti e altri commenti all'interno del codice per creare una documentazione automatica per l'inizio. Come posso gestire un progetto così grande e come posso creare una documentazione HTML sfogliabile? Come […]

PHPDoc per un'interface fluente in sottoclass?

C'è qualche motivo per rendere il mio IDE (in realtà PHPStorm) capire che: $student->setName('Marco'); Restituirà un'istanza di Student , senza ridefinire setName() nella sottoclass (solo per aggiungere commenti PHPDoc)? class Person { private $name; /** * @param string $name * @return Person */ public function setName($name) { $this->name = $name; return $this; } } class […]

Come usare PHPdoc in Eclipse

Siamo attualmente all'inizio di un nuovo progetto e vorremmo (per una volta) commentare il più ansible fin dall'inizio per aiutare lo sviluppo futuro. Ho cercato di scoprire quali sono le migliori pratiche di phpDoc in Eclipse, ma con risultati piuttosto sottili. Puoi condividere le tue migliori pratiche e trucchi per usare phpDoc per commentare cose […]

Completamenti di Eclipse – domanda @var (PHPDoc)

Ho un problema strano Quando utilizzo @return Model\Article nel metodo di caricamento del model, vedo i methods del model in completamento automatico di Eclipse. Il metodo di caricamento del model restituisce più oggetti, quindi lo voglio @return My\BaseModel e quindi metto il /* @var $model Model\Article */ per each model specifico (quando lo uso). Il […]

Documentare Ottieni / Posta parametri con Doxygen o PHPDoc

Stavo guardando la documentazione per PHPDoc e non sono riuscito a trovare un buon modo per documentare le variables Post che inviavo a vari methods. Così, ho iniziato a guardare in Doxygen con la speranza che mi avrebbe fornito un modo migliore per documentare tutte queste variables. Il mio codice richiede molte richieste AJAX, quindi […]

Come indicare che il metodo è una parte dell'interface con PHPDoc?

Come indicare che il metodo è una parte dell'interface con PHPDoc? Per esempio: /** * @implements BarInterface */ class Foo implements BarInterface { /** * @thisMethodIsHereBecauseItIsAPartOf("BarInterface") */ public function doBar() { } } C'è qualcosa di appropriato per sostituire @thisMethodIsHereBecauseItIsAPartOf("BarInterface") con?