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ó?