Come scrivere un commento in un linguaggio di programmazione per computer: 4 passaggi

Sommario:

Come scrivere un commento in un linguaggio di programmazione per computer: 4 passaggi
Come scrivere un commento in un linguaggio di programmazione per computer: 4 passaggi

Video: Come scrivere un commento in un linguaggio di programmazione per computer: 4 passaggi

Video: Come scrivere un commento in un linguaggio di programmazione per computer: 4 passaggi
Video: Come creare e formattare un DATABASE con OPENOFFICE 2024, Marzo
Anonim

Quando si programma su un computer, a volte è necessario lasciare note o commenti in modo che altri sviluppatori possano sfogliare il codice con facilità. Che si tratti di un progetto open source o di un progetto proprietario, sono necessari commenti per coordinarsi con i co-sviluppatori e anche con possibili futuri sviluppatori. Senza commenti, il codice sarebbe semplicemente irraggiungibile.

Passi

Scrivi un commento in un linguaggio di programmazione per computer Passaggio 1
Scrivi un commento in un linguaggio di programmazione per computer Passaggio 1

Passaggio 1. Comprendere lo scopo di commentare un programma per computer

  • La leggibilità è la cosa fondamentale qui. Quando guardi un commento dovresti sapere che è un commento e non una riga di codice.
  • Il commento dovrebbe essere utile non solo a te, ma a chiunque altro possa leggere il codice sorgente del tuo programma per computer.
Scrivi un commento in un linguaggio di programmazione per computer Passaggio 2
Scrivi un commento in un linguaggio di programmazione per computer Passaggio 2

Passaggio 2. Pensa a un modo breve e semplice per esprimere il tuo punto di vista

I commenti non devono necessariamente essere un'opera d'arte. Dovrebbero essere concisi, precisi e diretti al punto.

Ciò non dovrebbe, tuttavia, scoraggiare l'uso di più righe per un commento. Il punto è che l'informazione deve arrivare al lettore

Scrivi un commento in un linguaggio di programmazione per computer Passaggio 3
Scrivi un commento in un linguaggio di programmazione per computer Passaggio 3

Passaggio 3. Scrivere il commento utilizzando la sintassi appropriata fornita dal linguaggio di programmazione

Scrivi un commento in un linguaggio di programmazione per computer Passaggio 4
Scrivi un commento in un linguaggio di programmazione per computer Passaggio 4

Passaggio 4. Chiediti se il commento che hai scritto è sufficientemente dettagliato

Un commento dovrebbe essere in grado di dire a qualcuno che guarda il codice sorgente cosa fa effettivamente quella parte del programma senza doverlo compilare ed eseguirlo. Il tuo commento realizza questo? Trasmette tutti i dettagli?

Consigliato: