Qual è lo stato di PHPDoc?

Non mi è mai importato molto di documentare il mio codice prima, ma di recente ho iniziato a lavorare su un progetto open source e la necessità è nata. Ovviamente l'arma di scelta è PHPDoc, ma ...Qual è lo stato di PHPDoc?

Non riuscivo a trovare una singola specifica dello standard PHPDoc. C'è una voce di wikipedia che elenca alcune proprietà e c'è il progetto phpDocumentor, che presumibilmente ha un dizionario più esteso, ma quello che mi lascia perplesso è la guida definitiva di PHPDoc? C'è un singolo standard o è a tutti quei numerosi knockoff per phpDocumentor per estendere lo "standard" PHPDoc (se esiste) a quello che sembrano adattarsi.

Se assumiamo che phpDocumentor è il luogo in cui viene creato lo standard PHPDoc e mantenuto, le cose sembrano piuttosto triste, poiché the project's website è morto da circa quasi 4 anni. e ciò che ancor più mi lascia perplesso è che circa un mese fa una versione 1.4.4 è apparso improvvisamente dai morti sul sito Pear di phpDocumentor.

So che ci sono molti amici più intelligenti e ben informati da queste parti, quindi mi piacerebbe saperlo. Qual è l'accordo con PHPDoc. C'è una singola autorità che crea lo standard? Quanto è affidabile? C'è un futuro o abbiamo a che fare con uno zombie e ogni speranza è perduta ...

Grazie, Ivo

fonte

2012-01-02 Ivo Sabev

non una domanda per overflow dello stack –

@Dagon - Mi permetto di dissentire. Cade sotto ['problemi pratici e risolvibili che sono unici per la professione di programmazione'] (http://stackoverflow.com/faq). –

Per riferimento, un sito che non viene aggiornato da un po 'di tempo non rende "morto" il sito (o il progetto). Potrebbe essere solo che una nuova versione non è stata * necessaria * per oltre 3 anni, perché il software fa il suo dovere e lo fa bene. – cHao

Questa domanda è già un po 'vecchia, ma per motivi di informazione, devo aggiungere che DocBlox è stato unito a PhpDocumentor.

Annunciando phpDocumentor 2 - la fusione del vecchio (phpDocumentor) e la nuova (DocBlox).

con la prima versione alpha di phpDocumentor (2.0.0a1), il nuovo modello predefinito “Responsive” sfoggia un nuovo layout di pagina, insieme con i miglioramenti di layout utili che i modelli originali DocBlox forniti (che rimangono disponibili) sui vecchi modelli phpDocumentor (che andrà in pensione con phpDocumentor vecchio). Esplora questo nuovo modello allo http://demo.phpdoc.org/Responsive/index.html.

=>http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

PHPDoc è tornato all'azione. =)

fonte

2012-09-11 13:19:58 JCM

Secondo Wikipedia it's dead.

Le specifiche dello standard per i tag PhpDoc erano quelle elencate nella documentazione di PhpDocumentor. Ma come ho detto, è morto. Poiché DocBlox sembra riempire il vuoto lasciato da PhpDocumentor, consiglierei di utilizzare lo DocBlox documentation come base per come farai i tuoi commenti su PhpDoc.

Spero che Netbeans 7.1 introduca il supporto DocBlox perché è molto meglio. È consapevole di PHP 5.3 e viene mantenuto attivamente.

fonte

2012-01-02 10:40:06 GordonM

Grazie per il tuo commento. Sono a conoscenza della miriade di generatori di documenti là fuori, ma sembrano tutti estendersi sulla base di PHPDoc, quindi speravo segretamente che ci fosse uno standard unico, ma suppongo che forse no. La mia scelta personale di generatore per ora è - http://apigen.org –

Se tutti sembrano estendere phpDoc ... beh ... questo dovrebbe dirti qualcosa. Vale a dire, * è * uno standard principale per i commenti del doc. Il sistema che usi potrebbe cambiare, ma i commenti saranno praticamente gli stessi. – cHao

Ho inviato un'email a qualche sviluppatore di phpdocumentor, che mi ha informato che il progetto non è "morto", ma non verrà migliorato per ottenere le funzionalità di php 5.3 (l'articolo di wikipedia è stato aggiornato di conseguenza e non elenca più il progetto come non più disponibile) . Sono d'accordo con @IvoSabev, apigen è il mio nuovo preferito personale. – William

A partire da agosto 2013, lo PHP Framework Interoperability Group ha iniziato a scrivere una specifica formale (PSR) per PHPDoc. Lo standard proposto per PHPDoc, la bozza attuale PSR5: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

La bozza corrente aggiorna la specifica per indirizzo PHP 5.3+, oltre ad altre modifiche che si sono verificate.Credo che l'aspettativa è che questo standard per i commenti php sarà adottato da più generatori di documenti.

fonte

2014-08-31 22:14:46 Amgine

Qual è lo stato di PHPDoc?

risposta

Problemi correlati