PHP/athugasemdir

Um leið og skrifturnar verða flóknari verður ljóst að þú verður að vera alveg skýr, bæði fyrir þig og aðra, hvað það er sem þú ert að gera og af hverju þú ert að gera það. Athugasemdir og góðar nafnagiftir geta hjálpað þér að skrifa skiljanlegar skriftur vegna þess að:

Þegar það tekur lengri tíma en eina viku að skrifa skriftu munt þú ekki muna hvað þú varst að gera þegar þú byrjaðir en þig vantar nauðsynlega að muna það.
Allar skriftur sem eru notaðar reglulega munu þurfa endurskrift á einhverjum tímapunkti. Það ferli er mun auðveldar (og í flestum tilfellum aðeins hægt) ef þú skrifar niður hvað þú gerðir.
Ef þú vilt sýna einhverjum skrifturnar þínar er skemmtilegra að hafa þær snyrtilegar og fallegar.

Athugasemdir

Athugasemdir er sá hluti af kóðanum sem PHP þáttarinn sleppir. Þegar þáttarinn kemur að athugasemd mun hann einfaldlega halda áfram þangað til að athugasemdin endar án þess að gera nokkuð. PHP býður upp á athugasemdir sem eru bundnar við eina línu sem og fjöllínu.

Athugasemd í einni línu

Athugasemd í einni línu byrjar hvar sem þú vilt að hún byrji og endar við enda línunnar. Í PHP getur þú bæði notað // og # til að tákna slíka athugasemd en # er ekki mjög útbreitt og mælum við með að þú notir eingöngu // Slíkar athugasemdir eru aðallega notaðar til að segja lesandanum hvað þú ert að gera í næstu 2-5 línum fyrir neðan. Til dæmis:

 //Prenta út breytuna $skilabod
 echo $skilabod;

Það er miklvægt að skilja að athugasemd sem er bara ein lína hefur ekki áhrif á alla línuna heldur aðeins frá þeim stað sem hún byrjar. Þannig að við getum líka notað hana til að útskýra til hvers við bjuggum til einstaka breytu:

 $skilabod = ""; //Setur innihald breytunnar $skilabod sem tóman streng

$skilabod = ""; er keyrð en ekki restin af línunni.

Þó skal forðast að gefa jafn augljósar skýringar og hvað frumstilling breyta er að gera í athugasemdum, því það er mjög auðvelt að skrifa of mikið af athugasemdum. Við það myndast hávaði" (e. noise) sem gerir það að verkum að það sem virkilega skiptir máli týnist í hávaðanum.

Athugasemdir í einni línu enda annað hvort á:

línubili (þ.e. línubili ekki \n línubilsmerkingunni) EÐA:
lokunartagi PHP ( ?> )

Ef að athugasemd er lokað með lokunartagi PHP mun endirinn ekki verða að athugasemd og því mun 2 prentast á skjáinn:

// echo "1"; ?> echo "2";

Fjöllínu-athugasemdir

Slíkar athugasemdir spanna eins margar línur og þú vilt og geta verið notaðar til að t.d. skilgreina föll eða klasa eða bara til að geta skrifað athugasemd sem er of stór fyrir eina línu. Til að merkja upphaf slíkrar athugasemdar er notuð táknin /* og til að enda hana er notað */ Til dæmis:

 /* Þetta er
    fjöllínu-athugasemd
    Og það lokar þegar
    ég segi því að lokast
    When I tell it to.
  */

Fleiri upplýsingum verður bætt við síðar