PHPDoc

Vikipēdijas lapa
Pārlēkt uz: navigācija, meklēt

PHPDoc ir PHP dokumentēšanas formāls standarts, Javadoc adaptācija. Tas nosaka, kā jāveido komentāri programmu kodā. PHPDoc ļauj ārējiem dokumentācijas ģeneratoriem, piemēram, phpDocumentor, izveidot programmatūras koda dokumentāciju. Tāpat šadi koda komentāri palīdz dažām integrētām izstrādes vidēm, piemēram, Zend Studio, NetBeans, Aptana Studio, interpretēt mainīgo tipus un citas neviennozīmības tādā vāji tipizētā programmēšanas valodā, kāda ir PHP.

PHPDoc ļauj dokumentēt gan objektorientēto gan procedurālo kodu.

PHPDoc sastāv no komentāru blokiem, sauktiem par DocBlock. Tas ir paplašināts C++ stila PHP komentārs, kas sākas ar "/**" un beidzas ar "*/". Katras rindas sākumā jābūt "*". Rindas blokā, kuras nesākas ar "*", tiek ignorētas. DocBlock jāatrodas tieši pirms elementa, kuru tas dokumentē.

Funkcijas "foo()" dokumentēšanas piemērs:

/**
 * This is a DocBlock comment
 */
function foo()
{
}

Blokā var atrasties īpaši tagi, kas sākas ar "@" simbolu. Tie informē dokumentēšanas programmu, jā jāparāda informāciju un modificē dokumentācijas izskatu, kā arī ļauj definēt mainīgo tipus (tā kā PHP ir netipizēta valoda).

Atsevišķus PHP failus var apvienot vienā paketē, izmanojot @package tagu.

Ārējās saites[labot šo sadaļu | labot pirmkodu]