Voeg opmerkings in PHP by: 7 stappe (met prente)

Inhoud

Trappe
- Deel 1 van 2: Style
- Deel 2 van 2: Gebruik
Wenke

Opmerkings binne `n programmeertaal is sekere notas wat gebruik kan word om die doel en bedoeling van `n blok kode te verduidelik. Wanneer jy PHP gebruik, het jy veelvuldige opsies om van te kies wat spruit uit wyd gebruikte, ouer programmeertale met twee keuses wanneer dit kom by enkelreëlopmerkings en ook `n meerlynopmerkingsvorm, afgelei van die styl wat in die C gebruik word. programmeertaal. Jy kan opmerkings gebruik om te verhoed dat blokke kode uitgevoer word, en jy kan dit selfs gebruik om dokumentasie te genereer.

Trappe

Deel 1 van 2: Style

1. Gebruik eenreëlkommentaar vir kort opmerkings. As jy `n kort opmerking wil plaas, kan jy die eenreëlkode daarvoor gebruik. Hierdie opmerking gaan nie verder as die einde van die reël of die einde van die kodeblok nie. Hierdie tipe opmerking werk net binne PHP-merkers en sal gelees word as dit binne HTML-kode geplaas word.

1. Gebruik meerlynkommentaar vir meer uitgebreide kommentaar of kodetoetsing. Meerlynkommentaar is nuttig om `n langer verduideliking te skryf, of om te verhoed dat `n sekere kodesegment uitgevoer word. Lees die deel "Gebruik" hieronder vir `n paar wenke oor die gebruik van meerlynkommentaar.

Deel 2 van 2: Gebruik

1. Gebruik opmerkings om kommentaar te lewer oor hoe die kode werk. Dit is nie nodig om dit vir elke reël kode te doen nie, aangesien goed geskryfde kode maklik is vir ander programmeerders om te verstaan. Dit is nuttig as daar ongewone of onduidelike funksies in die kode is.

// Genereer krulversoek $sessie = curl_init($request); // Sê vir curl om HTTP POST curl_setopt te gebruik ($sessie, CURLOPT_POST, true);

Los `n opmerking sodat jy nie vergeet wat jy gedoen het nie. Wanneer jy aan jou eie projekte werk, kan opmerkings jou help om te onthou waar jy opgehou het. Lewer kommentaar op kode wat nie werk nie, of wat jy nog nie voltooi het nie.

// Moet hierna kyk voordat ek voortgaan eggo "Hello Wêreld!";

Lewer kommentaar op die kode wat jy wil deel. As jy van plan is om met ander saam te werk, of die kode oopbron wil maak, kan opmerkings ander help om uit te vind wat jou kenmerke doen en waar hulle kan verbeter.

/* Is daar `n meer effektiewe manier om dit te doen? */ Seks:

Gebruik opmerkings om te verhoed dat sekere blokke kode uitgevoer word. Dit is nuttig as jy iets wil toets en verhoed dat sekere kode uitgevoer word. Alles binne die opmerkingmerkers sal geïgnoreer word terwyl die webblad gelaai word.

2. Wees versigtig wanneer u kommentaar lewer op groot blokke kode. Die kommentaarfunksie sal stop wanneer die eerste eindmerker aangedui word, so as daar reeds `n meerlynopmerking binne die kode is wat jy wil kommentaar lewer, sal hierdie opmerking stop aan die einde van die geneste opmerking.

3. Gebruik opmerkings om pseudo-dokumentasie te skep. Jy kan `n bietjie kreatiewe formatering gebruik om dokumentasie vir jou kode direk in die kode te skep. Dit kan nuttig wees vir oopbronprojekte.

Wenke

HTML-opmerkings en PHP-opmerkings verskil, so as jy scripting (`n mengsel van HTML en PHP) gebruik, wees versigtig om nie die kommentaarkodes te verwar nie.
Byvoorbeeld, in die kode hieronder het dit HTML-opmerkings, maar PHP-kode word steeds uitgevoer. Die plasing van HTML-opmerkings binne PHP-etikette sal foute veroorsaak.