Hogyan dokumentáljam a PHP kódot?

Olvasási idő: < 1 perc

Megjelenés

PHP kód formázására a PSR irányelveket javaslom, ezekben a megjegyzések és a dokumentáció megjelenése is meg van határozva.

Az irányelvek főleg a phpDocumentor szabványait követi.

Tartalom

Minden esetben érdemes a legérthetőbben összefoglalni és jelölni az adott elem lényegét, és válaszolni erre a pár kérdésre.

  • Miért létezik?
  • Hogyan kell használni?
  • Milyen adattípusok érintettek?
  • Milyen egyéb programrészek kapcsolódnak az adott elemhez?
  • Ha van egyéb részletes dokumentáció akkor az hol található?
Hasznos volt ez számodra?
Dislike 0 0 személy 0 szavazatból hasznosnak találta ezt a leírást. Mi a te véleményed?
Ennyien néztétek már meg: 13

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé. A kötelező mezőket * karakterrel jelöltük

Ez az oldal az Akismet szolgáltatást használja a spam csökkentésére. Ismerje meg a hozzászólás adatainak feldolgozását .