Negli standard PEAR non esiste alcun riferimento all'HTML, se consentito o meno.
Ma vedo che alcune persone usano tag HTML come <kbd> e cose ..
Quindi l'HTML è permesso? Si romperà alcuni parser di documenti?
Vedi link
L'HTML è supportato nella Descrizione lunga :
The Long Description continues for as many lines as desired and may contain HTML markup for display formatting.
Esiste un elenco specifico di tag supportati da PHPDoc:
Here is a list of tags supported by phpDocumentor:
<b>-- emphasize/bold text<code>-- Use this to surround php code, some converters will highlight it<br>-- hard line break, may be ignored by some converters<i>-- italicize/mark as important<kbd>-- denote keyboard input/screen display<li>-- list item<ol>-- ordered list<p>-- If used to enclose all paragraphs, otherwise it will be considered text<pre>-- Preserve line breaks and spacing, and assume all tags are text (like XML's CDATA)<samp>-- denote sample or examples (non-php)<ul>-- unordered list<var>-- denote a variable name
Inoltre, sembra che una riga vuota tra i paragrafi sia interpretata come un'interruzione di paragrafo anche senza i tag <p> .
Secondo questa altra pagina seguono lo standard phpDoc. Dovresti seguire rigorosamente questo standard, anche se a volte si possono ipotizzare alcune estensioni comuni. Per codice pubblicamente disponibile (su altri progetti) non inserisco HTML nei miei commenti compatibili con phpDoc.
Leggi altre domande sui tag html php documentation documentation-generation