Commento

Spesso citato come una delle convenzioni di programmazione più utili e meno utilizzate, un commento è una nota di testo aggiunta al codice sorgente per fornire informazioni esplicative, di solito sulla funzione del codice. I commenti sono generalmente utili a qualcuno che mantiene o migliora il tuo codice quando non sei più in giro per rispondere a domande al riguardo. Gli sviluppatori peer a volte valutano il codice per la completezza e la leggibilità dei suoi commenti.

Per consentire al compilatore del linguaggio di programmazione di riconoscere i commenti e non confonderli con l'istruzione s, viene utilizzato un carattere speciale (come "#," "/ *," "'" e "//") per segnalare l'inizio o la fine di un commento. I caratteri iniziali del commento HTML ( "); il testo all'interno di questi caratteri di inquadratura dei commenti è tuttavia visibile a chiunque legga il codice. Leggendo questa pagina in un browser Web, ad esempio, è possibile selezionare" Visualizza "e quindi" Sorgente "per visualizzare il codice HTML per pagina, compresi i commenti.

Un programma dovrebbe includere almeno: a blocco commento file che descrive il contenuto del file, in modo che qualcuno che lo legge possa comprenderlo senza dover leggere il codice stesso, e un file blocco commento funzione che descrive ogni unità funzionale di codice. Inoltre, alcuni programmatori forniscono un commento per ciascuna dichiarazione di lingua.