Aggiungi commenti in PHP: 7 passaggi (con immagini)

Contenuto

Passi
- Parte 1 di 2: Stili
- Parte 2 di 2: Uso
Consigli

I commenti all`interno di un linguaggio di programmazione sono alcune note che possono essere utilizzate per chiarire lo scopo e l`intento di un blocco di codice. Quando usi PHP, hai più opzioni tra cui scegliere che derivano da linguaggi di programmazione più vecchi e ampiamente utilizzati con due scelte quando si tratta di commenti a riga singola e anche un modulo di commento a più righe, derivato dallo stile utilizzato in C linguaggio di programmazione. È possibile utilizzare i commenti per impedire l`esecuzione di blocchi di codice e persino utilizzarli per generare documentazione.

Passi

Parte 1 di 2: Stili

1. Usa il commento di una riga per i commenti brevi. Se vuoi pubblicare un breve commento, puoi utilizzare il codice di una riga per quello. Questo commento non va oltre la fine della riga o la fine del blocco di codice. Questo tipo di commento funziona solo all`interno di tag PHP e verrà letto se inserito all`interno del codice HTML.

1. Usa il commento su più righe per commenti più estesi o test del codice. I commenti su più righe sono utili per scrivere una spiegazione più lunga o per impedire l`esecuzione di un determinato segmento di codice. Leggi la parte "Utilizzo" di seguito per alcuni suggerimenti sull`utilizzo del commento su più righe.

Parte 2 di 2: Uso

1. Usa i commenti per lasciare commenti su come funziona il codice. Non è necessario farlo per ogni riga di codice, poiché il codice ben scritto è facile da capire per gli altri programmatori. È utile se nel codice sono presenti funzioni insolite o poco chiare.

// Genera richiesta curl $session = curl_init($request); // Di` a curl di usare HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Lascia un commento per non dimenticare quello che hai fatto. Quando lavori ai tuoi progetti, i commenti possono aiutarti a ricordare da dove eri rimasto. Commenta il codice che non funziona o che non hai ancora completato.

// Devo guardare questo prima di continuare l`eco "Ciao mondo!";

Commenta il codice che vuoi condividere. Se hai intenzione di collaborare con altri o vuoi rendere il codice open source, i commenti possono aiutare gli altri a scoprire cosa fanno le tue funzionalità e dove possono migliorare.

/* C`è un modo più efficace per farlo? */ Sesso:

Utilizzare i commenti per impedire l`esecuzione di determinati blocchi di codice. Ciò è utile se si desidera testare qualcosa e impedire l`esecuzione di un determinato codice. Tutto ciò che si trova all`interno dei tag di commento verrà ignorato durante il caricamento della pagina web.

2. Fai attenzione quando commenti blocchi di codice di grandi dimensioni. La funzione di commento si interromperà quando viene segnalato il primo tag di fine, quindi se c`è già un commento su più righe all`interno del codice che vuoi commentare, questo commento si fermerà alla fine del commento nidificato.

3. Usa i commenti per creare pseudo-documentazione. Puoi utilizzare una formattazione creativa per creare documentazione per il tuo codice direttamente nel codice. Questo può essere utile per i progetti open source.

Consigli

I commenti HTML e i commenti PHP sono diversi tra loro, quindi se stai usando lo scripting (un mix di HTML e PHP), fai attenzione a non confondere i codici di commento.
Ad esempio, nel codice seguente sono presenti commenti HTML, ma il codice PHP viene comunque eseguito. L`inserimento di commenti HTML all`interno di tag PHP causerà errori.