Megjegyzések (kommentek)

Teljes inline dokumentációs komment blokkokat (docblock-ok) kell készíteni. A dokumentációs blokkok PEAR-csomagokkal kapcsolatos részletezését lásd a Kézikönyv kódolási szabályainak Példa Fájl és a Fejléc komment blokkok fejezeteiben. További információ a phpDocumentor weboldalán érhető el.

Dokumentálásnál általános szabály, hogy amiről nem kívánunk leírást készíteni ("Nem akarom kipróbálni és dokumentálni..."), arról épphogy érdemes kommentet készíteni, mielőtt elfelejtjük hogyan működik.

Mind a C-stílusú kommentek (/* */), mind a C++ stílusúak (//) használata elfogadott. A Perl/shell-stílusú kommentek használata szigorúan ellenjavallt.

Függvénydefiníciók (Previous) Kód include-olása (Next)
Last updated: Thu, 24 Jul 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: jeff_walter@kace.com
Why exactly are you discouraging the use of # as a comment symbol? I happen to find the c-style comment symbols to be hard to look at...