I Commenti nel Linguaggio C
Argomenti: sintassi dei commenti, riga singola, blocchi multi-riga, best practices, Header Block di inizio file
I commenti sono elementi fondamentali della programmazione. Non sono istruzioni eseguite dal computer, ma note scritte dal programmatore per gli umani. Il compilatore C li ignora completamente durante la fase di compilazione.
1. Tipi di Sintassi per i Commenti in C
Sintassi: Commenti a riga singola (//) e commenti a blocco (/* */)
1. Commento a Riga Singola (//)
Inizia con due barre consecutive //. Tutto ciò che si trova dopo le due barre fino al termine della riga viene ignorato dal compilatore. Ideale per brevi note al fianco delle istruzioni.
int numero = 100; // Dichiarazione e inizializzazione
2. Commento a Blocco (/* ... */)
Inizia con /* e termina con */. Tutto ciò che è compreso tra questi delimitatori, anche distribuito su decine di righe, viene trattato come commento.
/* Questo è un commento
distribuito su più righe */
| 1 | /* |
| 2 | * Calcola l'area del cerchio dato il raggio |
| 3 | */ |
| 4 | float calcolaArea(float raggio) { |
| 5 | float area; |
| 6 | area = 3.14159f * raggio * raggio; // Formula: PI * r^2 |
| 7 | return area; |
| 8 | } |
Commento a Blocco (righe 1-3): Posizionato sopra l'intestazione di una funzione per spiegarne il compito principale.
Commento a Riga Singola (riga 6): Affiancato a un calcolo per richiamare al volo la formula matematica utilizzata.
2. Regole Fondamentali e Consigli (Best Practices)
Linee Guida: Come scrivere commenti utili ed evitare errori sintattici
Divieto di Annidamento
Non puoi inserire un commento a blocco dentro un altro. Il primo */ incontrato chiuderà l'intero commento causando un errore di compilazione.
Commenta il "Perché"
Evita di commentare l'ovvio (es. // incremento x per x++;). Spiega invece la motivazione logica di una scelta.
Disabilitare il Codice
Durante il debugging puoi usare // per disattivare una singola riga temporaneamente e /* ... */ per disattivare un intero blocco.
3. L'Intestazione del File (Header Block)
Standard Professionale: Blocco di documentazione iniziale obbligatorio nei progetti C
L'Header Block è un commento multi-riga posizionato all'inizio del file sorgente (prima di qualsiasi direttiva #include). Fornisce una carta d'identità del programma.
* File: calcolatrice.c
* Autore: Mario Rossi
* Data Creazione: 12/10/2025
* Ultima Modifica: 15/10/2025
*
* Descrizione:
* Programma calcolatore che riceve due numeri interi in input
* dall'utente e ne stampa a schermo la somma ed il prodotto.
*
* Compilazione: gcc calcolatrice.c -o calcolatrice
* Esecuzione: ./calcolatrice
*/
- File: Nome esatto del file sorgente (es.
calcolatrice.c). - Autore: Nome del creatore del codice.
- Data: Data di creazione e di ultima revisione.
- Descrizione: Sintesi del funzionamento, input previsti ed output prodotti.
- Compilazione: Comando da terminale consigliato per compilare il codice.
Osservazione
Inserire sempre l'Header Block all'inizio di ogni sorgente .c rende il codice immediatamente comprensibile e manutenibile, sia nei progetti scolastici/universitari che nel contesto dello sviluppo software professionale!
In sintesi
Argomenti: concetti principali, riepilogo, competenze
- I commenti vengono ignorati dal compilatore e servono a spiegare la logica del codice agli sviluppatori.
- Il C supporta i commenti a riga singola (//) e i commenti a blocco/multiriga (/* ... */).
- L'Header Block a inizio file è una buona norma per documentare autore, data e scopo del programma.
- Distinguere la sintassi tra commenti // e commenti /* ... */.
- Comprendere la regola del divieto di annidamento dei commenti a blocco.
- Applicare le regole di buona documentazione (commentare il 'perché' e non il 'cosa').
- Strutturare un blocco di intestazione (Header Block) professionale all'inizio del file .c.