petek, 4. februar 2011

Komentiranje objektno orientirane programske kode v razvojnem okolju Netbeans

Oblika komentarja v razvojnem okolju Netbeans, ki je potrebna za pravilen prikaz pomoči ob kombinaciji tipk ALT+ENTER:
/**
* Funkcija za preverjanje razpoložljivosti uporabniškega imena
* @param string $nick označuje uporabniško ime uporabnika
* @return boolean true če uporabnisko ime se ni uporabljeno, 
ali pa false ce je uporabniško ime že v uporabi
*/
function my_function($nick){
 //KOMPLEKSNA PROGRAMSKA KODA
 return 1;
}
V našem primeru, za metodo my_comment se prikaže spodnje okence za pomoč:


Zadeva se izkaže kot dobra praksa pri obsežnejših razredih (ang. class), kjer si je težje zapomniti pomen vseh parametrov funkcije

1 komentar:

  1. Odlično, da si si vzel čas in dognal, kakšna je pravilna sintaksa za to uporabno stvar.

    OdgovoriIzbriši