CKTIS / C
comments and documentation — concetto C23
C supporta commenti a blocchi `/* ... */` e di riga `// ...`; scompaiono in una fase iniziale della traduzione e i blocchi non possono annidarsi. La documentazione dovrebbe descrivere contratti e motivi invece di ripetere codice ovvio.
Versione: C23
Sintassi
comments and documentationC supporta commenti a blocchi /* ... */ e di riga // ...; scompaiono in una fase iniziale della traduzione e i blocchi non possono annidarsi. La documentazione dovrebbe descrivere contratti e motivi invece di ripetere codice ovvio.
Un commento di funzione dovrebbe indicare proprietà dei puntatori, unità delle dimensioni, significato del risultato e condizioni d’errore. Dentro un algoritmo è utile se spiega un invariante non ovvio o il motivo dell’ordine delle operazioni.
Un /* dentro un commento a blocchi non apre un nuovo livello; il primo */ termina tutto e può esporre codice accidentale. Una macro non può commentare testo arbitrario in modo affidabile; usa un #if 0 controllato e mantieni il testo valido per il preprocessore.
Esempi
#include <stdio.h>
int main(void) {
/* A block comment cannot be nested. */
int value = 6; // The line comment ends at the newline.
printf("%d\n", value + 1);
return 0;
}
Risultato
7
C supporta commenti a blocchi `/* ... */` e di riga `// ...`; scompaiono in una fase iniziale della traduzione e i blocchi non possono annidarsi. La documentazione dovrebbe descrivere contratti e motivi invece di ripetere codice ovvio.