commenti Strano sopra dichiarazioni di funzioni PHP

ho notato che un sacco di script hanno questo tipo di commenti:commenti Strano sopra dichiarazioni di funzioni PHP

/** 
* Retrieve list of themes with theme data in theme directory. 
* 
* The theme is broken, if it doesn't have a parent theme and is missing either 
* style.css and, or index.php. If the theme has a parent theme then it is 
* broken, if it is missing style.css; index.php is optional. The broken theme 
* list is saved in the {@link $wp_broken_themes} global, which is displayed on 
* the theme list in the administration panels. 
* 
* @since 1.5.0 
* @global array $wp_broken_themes Stores the broken themes. 
* @global array $wp_themes Stores the working themes. 
* 
* @return array Theme list with theme data. 
*/ 
function get_themes() { 
    global $wp_themes, $wp_broken_themes; 

    ... 

    return $wp_themes; 
}

Sembra una sorta di documentazione per la funzione, ma cosa succede con le parole anteporre con @?

Come @since, @global, @return, @access, @param ecc ...?

So cosa vogliono dire, ma perché hanno @ di fronte a loro? Devono identificarsi con qualche tipo di app per la documentazione?

fonte

2011-05-07 Alex

Wow Non ho mai guardato il codice sorgente WP in precedenza, "global $ wp_broken_themes' sembra un codice potenzialmente orribile! –

Non sono "strani". @Wesley: il codice WP è orrendo; bene, è PHP quindi vai a capire. –

@Tomalak per quanto riguarda l'odio di PHP: non è l'auto, è l'autista :) –

È lo standard JavaDoc. Molto probabilmente l'autore l'ha scelto perché la maggior parte degli IDE la formattano in modo automatico.

http://en.wikipedia.org/wiki/Javadoc

fonte

2011-05-07 22:56:17 pkluz

ehi grazie! conosci un IDE gratuito che fa questo? Sto usando "we builder 2010" e appaiono come commenti – Alex

NetBeans è un favoloso IDE gratuito che supporta Java (ofc.), C/++, Python, PHP e molto altro tramite i moduli! – pkluz

I secondo NetBeans, l'ho provato la settimana scorsa e sono rimasto colpito. Sono un drogato di Notepad ++ che cerca di smettere di fumare e passare a qualcosa di più potente. –

hanno bisogno di identificarsi con un qualche tipo di documentazione di app.?

Sono utili con i documentatori automatici come phpDocumentor e in generale sono un buon modo per documentare il codice. Come wasabi has pointed out, gli IDE possono captarli e fare alcune cose utili per te, come i suggerimenti del tipo di argomento della funzione.

Anche se non si sta documentando il proprio codice, è una buona abitudine essere in casa - proprio non si sente il bisogno di lasciarsi trasportare con esso ad alcune persone tendono a fare (documentando ogni possibile cosa).

fonte

2011-05-07 22:59:39

Sembra che è, più o meno, JavaDoc per PHP.

fonte

2011-05-07 23:02:19

È PHPDoc, che è un adattamento del formato Javadoc preferito.

Questi formati di documentazione sono entrambi leggermente più leggibili grazie alla loro consistenza forzata e utili per IDE e generatori di documentazione automatica come phpdoc.

fonte

2011-05-07 23:02:34 Ronny

Questo è sicuramente PHP Documentator. Le parti "@qualcosa" vengono utilizzate per aggiungere informazioni alla documentazione. Si prega di consultare PHP Documentator's documentation per i dettagli - ha anche uno strumento per generare file di documentazione dai commenti (here) nel formato di Documentator di PHP.

La speranza che ti aiuta.

fonte

2011-05-07 23:05:41 Tadeck

commenti Strano sopra dichiarazioni di funzioni PHP

risposta

Problemi correlati