Dall'autore: commentare è una di quelle funzionalità facili da implementare. Allo stesso tempo, questi elementi di modifica possono essere di grande beneficio per gli sviluppatori che passano il codice di mano in mano. Oggi imparerai come commentare un blocco in PhpStorm. Considereremo anche il resto delle funzionalità dell'ambiente di sviluppo per commentare i contenuti del programma.
La possibilità di commentare il codice è disponibile nella maggior parte dei linguaggi di programmazione (forse tutti, ma con vari gradi di disponibilità). In genere, le spiegazioni verbali vengono utilizzate per aiutare altri membri del team con ulteriori sviluppi o semplicemente per ricordare a se stessi che quest'area necessita di correzioni ("FIX ME").
Naturalmente, una spiegazione di ciò che è stato scritto è una benedizione. Ma con l'aiuto dei commenti puoi cancellare tutti i lati positivi del codice. Per evitare che ciò accada, è necessario distinguere tra tipi di commenti:
documentare. Una buona associazione sarebbe il concetto di documentazione per vari Software. Tali commenti aiutano nell'uso del codice, come un'istruzione. Tale commento non è percepito come superfluo, perché senza di esso non c'è modo. Immagina che qualcuno abbia utilizzato il framework di creazione e non ti dica come utilizzare il programma;
javascript. Avvio veloce
esplicativo. buon codice di solito non sono necessari. Più righe di commenti vedi in un programma, più è probabile che il programma sia scritto male. Naturalmente, questa non è una regola assoluta.
I commenti esplicativi possono essere utili per coloro che correggeranno il codice in futuro. Ad esempio, molti giovani professionisti vedono margini di miglioramento ovunque. Credono che tutto fosse peggio prima di loro, e ora è il momento di sistemare ogni singola caratteristica.
A volte una sensazione simile supera i professionisti. Ad esempio, quando tutto sembra sorprendentemente storto, deve esserci una soluzione migliore. Per impedire ai follower di cercare qualcosa di meglio, un programmatore può lasciare una nota come questa: #time_spent_here=24h
Dopo tali parole, poche persone vogliono trascorrere così tanto tempo. Quindi lo stai avvertendo molto diverse opzioni già ripreso. Allo stesso tempo, dovresti evitare tali attacchi: #i_hate_this, #try_to_do_better_ass%%le. In questo modo, stai mostrando solo un atteggiamento poco professionale. Non compromettere te stesso e il datore di lavoro.
Ma documentare i commenti al codice può anche diventare una zavorra per un programmatore. Di norma, si tratta di sezioni enormi che distraggono direttamente dalla programmazione. Ma per visualizzare il codice senza commenti, esiste una funzione corrispondente negli IDE principali. Non dovrebbe essere un'eccezione e PhpStorm, ma ahimè. Cerca la funzione nei documenti di aggiornamento.
Sebbene i commenti fossero intesi come chiarimento e aiuto allo sviluppo del team, queste funzionalità non vengono utilizzate così spesso. Di norma, i tag vengono posizionati dove vogliono interrompere l'esecuzione del codice. Diciamo che hai PHP incorporato in HTML. E non vuoi cancellarlo, vuoi solo vedere come appare la pagina senza di esso. Per fare ciò, è necessario seguire la seguente sintassi:
javascript
…
…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div > |
Come puoi vedere, con semplici azioni, puoi interrompere l'esecuzione del codice senza nemmeno eseguire operazioni complesse. Ma, in realtà, questo non è ancora il massimo dell'ottimizzazione. Ulteriore comodità per lo sviluppatore è fornita dall'IDE phpStorm stesso. Utilizzando l'evidenziazione e le scorciatoie da tastiera, puoi commentare il segmento di codice selezionato senza assegnare tag specializzati. Si può fare così.
Utilizzando un metodo conveniente per te, seleziona una parte di testo (mouse, scorciatoie).
Premi la scorciatoia da tastiera Ctr + Maiusc + /
Inoltre, puoi commentare la riga corrente. Comunque, solo senza Shift.
Il vantaggio di questo tipo di commento è la copertura simultanea di più lingue. PHP è raro da solo. In questo modo non devi ricorrere a taggare ciascuno di essi. L'ambiente supporta molti altri linguaggi web. Basta selezionare un frammento e vendere la combinazione: questo è il codice multilingue e commentato. Allo stesso modo, può essere reso attivo.
È tutto quello che abbiamo. Se non hai mai utilizzato queste funzionalità prima, ti invitiamo a iniziare. Le abbreviazioni rendono il lavoro più veloce e migliore.
javascript. Avvio veloce
Impara le basi di JavaScript con un esempio pratico di creazione di un'applicazione web
In questa lezione, ti mostrerò come fare commenti in HTML, CSS, PHP. I commenti sono testi non visibili su una pagina web. Sono utilizzati per tutti i tipi di spiegazioni, promemoria, descrizioni per i webmaster, che consentono di strutturare il documento. I commenti sono indispensabili durante il debug del codice, consentono di navigare rapidamente nel markup di una pagina Web e trovare il blocco desiderato. I commenti vengono spesso utilizzati per eseguire il debug del codice HTML. Ad esempio, puoi commentare temporaneamente un blocco specifico di codice in modo che non venga eseguito e, se necessario, è facile ripristinarlo.
In HTML, i commenti sono formati utilizzando i caratteri:. Pertanto, qualsiasi testo tra questi caratteri è un commento. Considera un esempio:
Un esempio di commenti in HTML
I commenti in CSS vengono creati utilizzando i caratteri: /* e */. Per creare un commento basta inserire il codice della pagina web tra questi caratteri:
/* Inizio del blocco con stili per Corpo*/ corpo ( background: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; padding: 0px; ) /* Fine del blocco con stili per Corpo*/
I commenti in PHP possono essere a riga singola o multilinea:
1) I commenti a riga singola in PHP vengono creati utilizzando i caratteri: //. Basta mettere questo carattere prima della riga e verrà commentata Questa opzione viene utilizzata quando il commento è composto da una sola riga.
2) Per implementare commenti su più righe, vengono utilizzati i seguenti simboli: /* e */. Questa opzione è utile se il commento si estende su più righe.
Così abbiamo imparato a
I commenti in PHP sono simili ai commenti utilizzati in HTML. Nella sintassi PHP, i commenti iniziano sempre con una sequenza speciale di caratteri e qualsiasi testo che appare tra questi caratteri speciali verrà ignorato dall'interprete.
In HTML, lo scopo principale di un commento è quello di fungere da nota per gli sviluppatori che possono visualizzare il codice sorgente del tuo sito. I commenti PHP differiscono in quanto non verranno visualizzati dai visitatori. L'unico modo per visualizzare i commenti PHP è aprire il file per la modifica. Questo rende i commenti PHP utili solo per i programmatori PHP.
Nel caso ti fossi dimenticato o non sapessi come vengono fatti i commenti in HTML, guarda l'esempio qui sotto.
Mentre html ha un solo tipo di commento, PHP ne ha due. Il primo tipo che discuteremo è il commento a riga singola. Cioè, un commento che dice all'interprete di ignorare qualunque cosa accada su quella riga a destra dei commenti. Per usare questo commento, usa i caratteri "//" o "#" e tutto il testo a destra sarà ignorato dall'interprete PHP.
Psst...Non puoi vedere i miei commenti PHP!; // echo "niente"; // echo "Mi chiamo Humperdinkle!"; # echo "Neanch'io faccio niente"; ?>
Risultato:
Ciao mondo! Psst...Non puoi vedere i miei commenti PHP!
Si noti che molti dei nostri comandi echo non sono stati elaborati perché li abbiamo commentati con caratteri di commento speciali. Questo tipo di commento viene spesso utilizzato per scrivere rapidamente su codice complesso e offuscato o per rimuovere temporaneamente una riga di codice PHP (a scopo di debug).
Come i commenti HTML, i commenti multilinea in PHP possono essere usati per commentare grandi blocchi di codice o per scrivere commenti su più righe. I commenti su più righe in PHP iniziano con "/*" e terminano con "*/". Qualunque cosa tra questi caratteri verrà ignorata.
Risultato.
... oggi siamo in questo breve ma utile articolo, scopriremo come viene commentato il codice di vari programmi. Non parlerò molto, perché se sei interessato a questo, allora hai già incontrato le domande di questo compito e ne hai un'idea.
Sei capitato nel posto giusto... ma poche parole per chiarezza e utilità. Devi aver visto come si fa con il codice CSS, dato che i css sono di grande interesse per molti principianti, come me.
… Bene!
Ma nota che i commenti sono usati anche in html e php... Ma la maggior parte dei principianti si confonde nella fase iniziale del proprio lavoro con il sito e non sa come aggiungere a se stessi le spiegazioni necessarie. Dopotutto, succede allo stesso modo, ad esempio, devi disattivare per un po 'di tempo codice html, e poi riprendi la sua funzione - questo è facile da implementare se hai preso appunti sui "margini", ma non sai mai cosa.
Ma ciò che dovrebbe essere ricordato sui "commenti" in generale: tutto qui dipende strettamente dal file con cui stai lavorando in modo specifico, e quindi il codice dell'applicazione è diverso.
Ecco come ti spieghi. Oppure puoi generalmente commentare questo script css in questo modo: basta avvolgere
/* CODICE qui */
/*a:hover, a:focus ( color: #D5071E; text-decoration: underline; /*BOTTOM UNDERLINE*/ )*/
Attiro la tua attenzione sul fatto che puoi commentare l'intero ciclo di codice css in questo modo, ma !! quindi dovrai rimuovere i commenti ripetuti /* UNDERSTRING BELOW */, o giocare con le barre se la spiegazione è importante))
Altrimenti ci sarà un errore!!
Nota:
Se apri il codice sorgente della pagina - Ctrl + U e dai un'occhiata ... vedremo che il pezzo di codice css commentato è perfettamente visualizzato nel documento generato! questo è se css è stato utilizzato (le proprietà sono state impostate) direttamente in html
E, come capisci, se segui il collegamento dal codice sorgente al documento css del tuo modello attivo, puoi osservare e studiare tutti i commenti)) se qualcuno ne ha bisogno. Ma è improbabile.)
Il dialetto inglese (parole) sarà leggibile. Simboli russi - no.
Il file XML è commentato allo stesso modo.
Importante: controlla sempre il codice proposto negli articoli, almeno visivamente, altrimenti potrebbero esserci degli errori.
La semplice incuria di formattazione può costare tempo, ad esempio, il codice COMMENTATO mostrato sopra è spesso sbagliato: invece di due brevi trattini, si profila un trattino lungo:
Per vostra informazione:
come accennato nell'osservazione precedente, lo è anche il commento ... il codice html viene visualizzato nel documento generato!
Tienilo a mente.
Ed ecco qualcos'altro:
oltre al fatto che il codice commentato viene visualizzato nel codice sorgente della pagina (e quindi viene elaborato in un certo senso, anche se sarà invisibile sulla pagina!) - è meglio rimuovere alcune funzioni php insieme a html dal documento attivo.
Per esempio:
sarà visibile nel documento e nella funzionefarà il suo lavoro egregiamente: cioè, nel front-end le informazioni non saranno visibili, ma nel codice sorgente saranno chiaramente visualizzate! e questa è una richiesta su misura al database: tutto questo è una sciocchezza, ma devi saperlo!
È possibile farlo se non si desidera estrarre un pezzo di codice dal documento:
aggiungere prima della necessaria apertura del codice html "extra".… funzione inline… e chiusura?> …
In una parola, questo è ciò che puoi fare se il codice è grande:
allora la fonte sarà pulita!
O più semplicemente:
Commentiamo la funzione stessa nel documento html. Il codice sorgente in questi casi riguardanti lo sviluppo delle funzioni sarà pulito!
Questo codice JavaScript di esempio - per chiarezza, l'ho preso in rete, correggendo leggermente la punteggiatura. Non importa... L'importante è capire il principio...
Come hai capito, la barra "//" è doppia, questo è il SEGNO del commento ... SINGLE-LINE!
E il resto del codice JS è commentato come php , ne parleremo più avanti:
Nota:
Ma nota che può essere commentato proprio come il codice CSS.
... oppure puoi commentare in questo modo - una versione a una riga, quando usiamo NON DUE BARRE, ma BEKAR (cancelletto) prima della riga commentata:
…Naturalmente, i commenti dovrebbero essere fatti con attenzione nel ciclo del codice!
... o in questo modo - simile all'esempio CSS mostrato sopra ... cioè questa /* code */ opzione di commento è adatta sia per i codici CSS che per i codici JS!
Ma in questo modo puoi commentare una spiegazione più voluminosa del codice PHP, da qualche parte tra i suoi esempi principali ...
Puoi anche commentare nei cicli php se il codice è misto ... php e in qualche modo html
Simile a sopra:
Ad esempio, alcune di queste funzioni ... da qualche parte nel codice generale (o un ciclo in html):- puoi commentare, ad esempio aggiungere la tua etichetta in questo modo:
o così: una battuta...
Intelligenza:
il codice php non è visibile in nessun codice sorgente!! è visibile solo il suo risultato funzionale: lavorare!
Questo è tutto ciò che volevo segnalare oggi!
Ora puoi sperimentare... Buona fortuna.
E, naturalmente, leggi gli articoli del sito e iscriviti:
Condivido la mia amara esperienza - una certa conoscenza, per il tuo dolce benessere))
...la città dei webmaster Michalika.ru© - facilmente con WordPress
25.04.2017
Ciao a tutti!
Continuiamo a imparare le basi di PHP da zero!
In questa lezione ti dirò cos'è un commento in PHP e in pratica proveremo a scrivere il tuo commento nel codice. Ma non è tutto. Voglio anche dirti come commentare il codice e perché dovrebbe essere fatto.
In cosa consiste un commentoPHP
Commenta dentroPHPè un suggerimento per sviluppatori php per un rapido orientamento nel codice, oltre che per la modifica.
Un commento in PHP non è visibile all'utente che ha aperto la pagina Web per la visualizzazione. Anche se l'utente decide di guardare il codice sorgente della pagina, il commento non sarà comunque visibile, poiché tutti i file php.
Esistono 2 tipi di commenti per il codice PHP:
→ una riga
→ multilinea
⇒ Commento a riga singola per PHP
Per un commento a riga singola, utilizza i caratteri "//" o "#"
Dopo questi caratteri, tutto ciò che è scritto su una riga verrà ignorato e trattato come un commento.
Iscriviti per aggiornare"; # iscriviti (questo è un commento) ?>
Iscriviti per aggiornare
⇒ Commento multilinea per PHP
Un commento su più righe per PHP inizia con "/*" e termina con "*/".
Qualsiasi cosa tra questi caratteri verrà ignorata e trattata come un commento.
Un commento su più righe viene utilizzato se sono presenti più righe nella voce.
Sullo schermo, vedrai solo il seguente testo:
Ciao lettori del blog - sito !!!
PS: Commenta sempre il tuo codice. Se pensi di ricordare tutto ciò che hai fatto nel codice in 1-2 anni, ti sbagli, la possibilità è molto piccola. Anche se ricordi, dovrai dedicare molto tempo allo studio: cosa, dove e perché ...
Renditi il futuro piacevole - commenta il codice e poi dirai a te stesso "GRAZIE!!!".
Lascia un commento nel codice, ci vorrà 1 minuto del tuo tempo, ma ti farà risparmiare un'intera giornata in futuro.
Supponiamo che tu abbia scritto un codice php, ma per qualche motivo devi rimuovere 2 righe dal codice.
Non ho fretta di rimuovere qualcosa dal codice, specialmente se si tratta di codice php, farei meglio a commentarlo. E all'improvviso sarà necessario restituire il codice. È più facile decommentare che scrivere codice in un modo nuovo.
Come commentare il codice inPHP
Un esempio con un commento a riga singola:
Iscriviti per aggiornare"; ?>
Un esempio con un commento su più righe.
