Från författaren: kommentera är en av de funktioner som är lätta att implementera. Samtidigt kan dessa redigeringselement vara till stor nytta för utvecklare som skickar kod från hand till hand. Idag kommer du att lära dig hur du kommenterar ett block i PhpStorm. Vi kommer också att överväga resten av funktionaliteten i utvecklingsmiljön för att kommentera innehållet i programmet.
Möjligheten att kommentera kod finns på de flesta programmeringsspråk (kanske alla, men med varierande grad av tillgänglighet). Vanligtvis används verbala förklaringar för att hjälpa andra teammedlemmar med vidareutveckling, eller helt enkelt för att påminna sig själva om att detta område behöver korrigeras ("FIX ME").
Naturligtvis är en förklaring av vad som skrevs en välsignelse. Men med hjälp av kommentarer kan du stryka över kodens alla goda sidor. För att förhindra att detta händer är det nödvändigt att skilja mellan typer av kommentarer:
dokumentera. En bra förening vore begreppet dokumentation för olika programvara. Sådana kommentarer hjälper till att använda koden, som en instruktion. Sådana kommentarer upplevs inte som överflödiga, för utan den finns det ingen väg. Föreställ dig att någon har använt författarramverket och inte berättar hur du använder programmet;
JavaScript. Snabb start
förklarande. bra kod de behövs vanligtvis inte. Ju fler rader av kommentarer du ser i ett program, desto mer sannolikt är det att programmet är dåligt skrivet. Naturligtvis är detta inte en absolut regel.
Förklarande kommentarer kan vara användbara för dem som kommer att rätta koden i framtiden. Till exempel ser många unga yrkesverksamma utrymme för förbättringar överallt. De tror att allt var värre före dem, och nu är det dags att fixa varenda funktion.
Ibland övervinner en liknande känsla proffs. Till exempel när allt ser förvånansvärt snett ut – det måste finnas en bättre lösning. För att hindra följare från att leta efter något bättre kan en programmerare lämna en anteckning så här: #time_spent_here=24h
Efter sådana ord är det få som vill spendera så mycket tid. Så du varnar mycket för det olika alternativ redan tagit över. Samtidigt bör du undvika sådana attacker: #i_hate_this, #try_to_do_better_ass%%le. På så sätt visar du bara en oprofessionell attityd. Kompromissa inte med dig själv och arbetsgivaren.
Men att dokumentera kodkommentarer kan också bli ballast för en programmerare. Som regel är dessa massiva avsnitt som distraherar direkt från programmering. Men för att visa koden utan kommentarer finns det en motsvarande funktion i huvud-IDEerna. Borde inte vara ett undantag och PhpStorm, men tyvärr. Leta efter funktionen i uppdateringsdokumenten.
Även om kommentarer var avsedda som ett förtydligande och hjälp till teamutveckling, används dessa funktioner inte så ofta. Som regel placeras taggar där de vill stoppa exekveringen av koden. Låt oss säga att du har PHP inbäddat i HTML. Och du vill inte radera den, du vill bara se hur sidan ser ut utan den. För att göra detta måste du följa följande syntax:
JavaScript
…
…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div > |
Som du kan se, med enkla åtgärder, kan du stoppa exekveringen av koden utan att ens utföra några komplexa operationer. Men i själva verket är detta ännu inte höjden av optimering. Ytterligare bekvämlighet för utvecklaren tillhandahålls av själva phpStorm IDE. Med hjälp av markering och kortkommandon kan du kommentera det valda kodsegmentet utan att tilldela speciella taggar. Det kan göras så här.
Använd en metod som är bekväm för dig och välj ett stycke text (mus, genvägar).
Tryck på kortkommandot Ctr + Shift + /
Dessutom kan du kommentera den aktuella raden. Ändå, bara utan Shift.
Fördelen med denna typ av kommentarer är den samtidiga täckningen av flera språk. PHP är ovanligt i sig. På så sätt behöver du inte ta tag i var och en. Miljön stöder flera fler webbspråk. Välj bara ett fragment och sälj kombinationen - det är den flerspråkiga koden och kommenterade. På samma sätt kan den göras aktiv.
Det är allt vi har. Om du inte har använt dessa funktioner tidigare rekommenderar vi att du börjar. Förkortningar gör arbetet snabbare och bättre.
JavaScript. Snabb start
Lär dig grunderna i JavaScript med ett praktiskt exempel på hur du bygger en webbapplikation
I den här lektionen ska jag visa dig hur du gör kommentarer i HTML, CSS, PHP. Kommentarer är text som inte syns på en webbsida. De används för alla typer av förklaringar, påminnelser, beskrivningar för webbansvariga, vilket gör att du kan strukturera dokumentet. Kommentarer är oumbärliga vid felsökning av kod, de låter dig snabbt navigera i markeringen av en webbsida och hitta önskat block. Kommentarer används ofta för att felsöka HTML-kod. Du kan till exempel tillfälligt kommentera ett specifikt kodblock så att det inte exekveras, och om det behövs är det enkelt att återställa det.
I HTML skapas kommentarer med hjälp av tecken:. Alltså är all text mellan dessa karaktärer en kommentar. Tänk på ett exempel:
Ett exempel på kommentarer i HTML
Kommentarer i CSS skapas med tecknen: /* och */. För att skapa en kommentar behöver du bara lägga webbsidans kod mellan dessa tecken:
/* Början av block med stilar för Body*/ body ( bakgrund: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; marginal: 0px; utfyllnad: 0px; ) /* Slut på blocket med stilar för Body*/
Kommentarer i PHP kan vara enradiga eller flerradiga:
1) Enradskommentarer i PHP skapas med tecknen: //. Det räcker med att bara sätta detta tecken före raden så kommer det att kommenteras bort.Detta alternativ används när kommentaren bara består av en rad.
2) För att implementera flerradskommentarer används följande symboler: /* och */. Det här alternativet är användbart om kommentaren sträcker sig över flera rader.
Så har vi lärt oss
Kommentarer i PHP liknar kommentarer som används i HTML. I PHP-syntax börjar kommentarer alltid med en speciell sekvens av tecken, och all text som visas mellan dessa specialtecken kommer att ignoreras av tolken.
I HTML är huvudsyftet med en kommentar att fungera som en anteckning till utvecklare som kan se din webbplats källkod. PHP-kommentarer skiljer sig åt genom att de inte kommer att visas för besökare. Det enda sättet att se PHP-kommentarer är att öppna filen för redigering. Detta gör PHP-kommentarer endast användbara för PHP-programmerare.
Om du glömde eller inte visste hur kommentarer görs i HTML, se exemplet nedan.
Medan html bara har en typ av kommentar, har PHP två typer. Den första typen vi kommer att diskutera är en rad kommentar. Det vill säga en kommentar som säger åt tolken att ignorera vad som än händer på den raden till höger om kommentarerna. För att använda denna kommentar, använd tecknen "//" eller "#" och all text till höger kommer att ignoreras av PHP-tolken.
Psst...Du kan inte "se mina PHP-kommentarer!"; // eka "ingenting"; // echo "Jag heter Humperdinkle!"; # echo "Jag gör ingenting heller"; ?>
Resultat:
Hej världen! Psst...Du kan inte se mina PHP-kommentarer!
Observera att flera av våra ekokommandon inte bearbetades eftersom vi kommenterade dem med speciella kommentarstecken. Den här typen av kommentarer används ofta för att snabbt skriva om komplex och obfuskerad kod, eller för att tillfälligt ta bort en rad PHP-kod (för felsökningssyfte).
Liksom HTML-kommentarer kan flerradskommentarer i PHP användas för att kommentera stora kodblock eller för att skriva kommentarer på flera rader. Flerradskommentarer i PHP börjar med "/*" och slutar med "*/". Allt mellan dessa karaktärer kommer att ignoreras.
Resultat.
... idag är vi i denna korta men användbara artikel, vi kommer att ta reda på hur olika programkoder kommenteras. Jag kommer inte att prata mycket, för om du är intresserad av det här, har du redan stött på frågorna om denna uppgift, och du har en idé om det.
Du har kommit till rätt ställe... men några ord för tydlighet och användbarhet. Du måste ha sett hur det går till med CSS-kod, eftersom css är mest intressant för många nybörjare, som jag.
… Bra!
Men observera att kommentarer också används i html och php... Men de flesta nybörjare blir förvirrade i det inledande skedet av sitt arbete med webbplatsen och vet inte hur man lägger till de nödvändiga förklaringarna till sig själva. Det händer trots allt på samma sätt, till exempel måste du inaktivera en tid html-kod, och sedan återuppta dess funktion igen - detta är lätt att implementera om du gjorde anteckningar om "marginalerna", men du vet aldrig vad.
Men vad bör man komma ihåg om "kommentarer" i allmänhet - allt här är strikt beroende av vilken fil du arbetar med specifikt, och därför är applikationskoden annorlunda.
Så här förklarar du dig själv. Eller så kan du generellt kommentera detta css-skript så här: bara wrap
/* KOD här */
/*a:hover, a:focus ( färg: #D5071E; text-dekoration: understrykning; /*NEDERLINJE UNDERLINE*/ )*/
Jag uppmärksammar dig på det faktum att - du kan kommentera hela cykeln av css-kod på detta sätt, men !! då måste du ta bort upprepade kommentarer /* UNDERSTRÄNG UNDER */, eller leka med snedstreck om förklaringen är viktig))
Annars blir det fel!!
Notera:
Om du öppnar sidans källkod - Ctrl + U och tar en titt ... kommer vi att se att den utkommenterade css-koden visas perfekt i det genererade dokumentet! detta är om css användes (egenskaper sattes) direkt i html
Och, som du förstår, om du följer länken från källkoden till css-dokumentet för din aktiva mall, kan du observera och studera alla kommentarer)) om någon behöver det. Men det är osannolikt.)
Engelsk dialekt (ord) kommer att vara läsbar. Ryska symboler - nej.
XML-filen kommenteras på samma sätt.
Viktigt: kontrollera alltid koden som föreslås i artiklarna, åtminstone visuellt, annars kan det uppstå fel.
Enkel slarv i formateringen kan kosta tid, till exempel är den KOMMENTERADE koden som visas ovan ofta fel: istället för två korta bindestreck skymtar ett em-streck:
För din information:
som nämnts i föregående kommentar - så är kommentaren ... HTML-koden visas i det genererade dokumentet!
Ha detta i åtanke.
Och här är något annat:
förutom det faktum att den kommenterade koden visas i sidans källkod (och därför bearbetas i någon mening, även om den kommer att vara osynlig på sidan!) - är det bättre att ta bort vissa php-funktioner i kombination med html från det aktiva dokumentet.
Till exempel:
kommer att synas i dokumentet och funktionendet kommer att göra sitt jobb anmärkningsvärt bra: det vill säga i front-end kommer informationen inte att vara synlig, men i källkoden kommer den att visas tydligt! och detta är en bespontovy begäran till databasen: allt detta är en bagatell, men du måste veta!
Det är möjligt att göra detta om du inte vill ta ut en kodbit från dokumentet:
lägg till innan den nödvändiga "extra" html-koden öppnas… inline-funktion… och stängning?> …
Med ett ord, det här är vad du kan göra om koden är stor:
då blir källan ren!
Eller enklare:
Låt oss kommentera själva funktionen i html-dokumentet. Källkoden i dessa fall angående utveckling av funktioner kommer att vara ren!
Detta exempel på JavaScript-koden - jag, för tydlighetens skull, tog tag i nätet och korrigerade skiljetecken något. Det spelar ingen roll... Huvudsaken är att förstå principen...
Som du förstår är snedstrecket "//" dubbelt, detta är tecknet på kommentaren ... ENRAD!
Och resten av JS-koden kommenteras som php , mer om det nedan:
notera:
Men observera att det kan kommenteras precis som CSS-kod.
... eller så kan du kommentera så här - en enradsversion, när vi INTE använder TVÅ STRECK, utan BEKAR (hash) före den kommenterade raden:
…Naturligtvis ska kommentering göras noggrant i kodslingan!
... eller på detta sätt - liknande CSS-exemplet som visas ovan ... dvs. detta /* kod */ kommentarsalternativ är lämpligt för både CSS- och JS-koder!
Men på detta sätt kan du kommentera en mer omfattande förklaring av PHP-koden, någonstans mellan dess huvudexempel ...
Du kan också kommentera i php-cykler om koden är blandad ... php och på något sätt html
Liknande ovan:
Till exempel, någon sådan funktion ... någonstans i den allmänna koden (eller en loop i html):- du kan kommentera, d.v.s. lägga till din etikett så här:
eller så här: en one-liner...
Intelligens:
php-koden syns inte i några källkoder!! endast dess funktionella resultat är synligt - fungerar!
Det var allt jag ville rapportera idag!
Nu kan du experimentera... Lycka till.
Och naturligtvis, läs artiklarna på webbplatsen och prenumerera:
Jag delar med mig av min bittra erfarenhet - lite kunskap, för ditt söta välbefinnande))
...webbmästarnas stad Michalika.ru© - enkelt med WordPress
25.04.2017
Hej alla!
Vi fortsätter att lära oss grunderna i PHP från grunden!
I den här lektionen kommer jag att berätta vad en kommentar är i PHP och i praktiken kommer vi att försöka skriva din kommentar i koden. Men det är inte allt. Jag vill också berätta hur man kommenterar koden och varför det överhuvudtaget bör göras.
Vad är en kommentar iPHP
Kommentera inPHPär ett php-utvecklartips för snabb orientering i koden, såväl som för redigering.
En kommentar i PHP är inte synlig för användaren som öppnade webbsidan för visning. Även om användaren bestämmer sig för att titta på sidans källkod, kommer kommentaren fortfarande inte att vara synlig, eftersom alla php.
Det finns två typer av kommentarer för PHP-kod:
→ one-liner
→ flerlinje
⇒ En rad kommentar för PHP
För en enradskommentar, använd tecknen "//" eller "#"
Efter dessa tecken kommer allt som skrivits på en rad att ignoreras och behandlas som en kommentar.
Prenumerera på uppdatering"; # prenumerera (detta är en kommentar) ?>
Prenumerera för att uppdatera
⇒ Flerradskommentar för PHP
En flerradskommentar för PHP börjar med "/*" och slutar med "*/".
Allt mellan dessa karaktärer kommer att ignoreras och behandlas som en kommentar.
En kommentar med flera rader används om det finns flera rader i posten.
På skärmen ser du bara följande text:
Hej läsare av bloggen - sajt !!!
P.S.: Kommentera alltid din kod. Om du tror att du kommer ihåg allt som du gjorde i koden om 1-2 år så har du fel, chansen är väldigt liten. Även om du kommer ihåg kommer du att behöva spendera mycket tid på att studera - vad, var och varför ...
Gör framtiden trevlig för dig själv - kommentera koden så säger du till dig själv "TACK!!!".
Lämna en kommentar i koden, det tar 1 minut av din tid, men det sparar dig en hel dag i framtiden.
Låt oss säga att du skrev en php-kod, men av någon anledning måste du ta bort 2 rader från koden.
Jag har inte bråttom att ta bort något från koden, speciellt om det är php-kod så är det bäst att jag kommenterar det. Och plötsligt kommer det att bli nödvändigt att returnera koden. Det är lättare att avkommentera än att skriva kod på ett nytt sätt.
Hur man kommenterar ut kod inPHP
Ett exempel med en kommentar på en rad:
Prenumerera för att uppdatera"; ?>
Ett exempel med en flerradskommentar.
