Come formattare il codice C/C++ per il forum

[M.A.W. 1968]

Una esigenza quotidiana per gli utenti di questa sezione del forum è l'invio di stralci di codice sorgente C o C++ nei propri post.

Purtroppo, altrettanto spesso capita che tale codice risulti pressoché illeggibile a causa di uso di caratteri di tabulazione, formattazioni inadeguate, o addirittura mancato uso dei tag appositi.

Il risultato, a causa della sua scarsa leggibilità, sovente disincentiva altri utenti dal prendere in considerazione la domanda e dal risolvere il problema, provocando perdite di tempo o potenziali errori di comprensione.

In definitiva, una pessima (o mancata) formattazione va decisamente contro l'interesse stesso di chi pone la domanda e non contribuisce al buon ordine e alla qualità del forum.


Ancora una volta si ricorda l'assoluta opportunità di racchiudere il codice sorgente entro la coppia di tag [code] e [/code].
Parimenti è raccomandabile formattare il codice senza uso di caratteri di tabulazione '\t' e con indentazione pari a esattamente quattro spazi, per migliorare la leggibilità.

Sarebbe decisamente poco pratico fornire qui indicazioni dettagliate su come configurare ogni singolo ambiente, ogni IDE, ogni editor (sono centinaia !) per ottenere tale risultato; d'altro canto, formattare manualmente il codice sarebbe improponibile, sia da parte di chi pone la domanda, sie (doppiamente !) da parte di chi prende in carico l'analisi del codice proposto.
Ci si attende ragionevolmente che un programmatore - per quanto studente, neofita, aspirante... - sappia come minimo usare un pretty printer, e lo usi d'abitudine.

Per una formattazione decente "al volo" del codice C/C++ prima di allegarlo ad un post è possibile utilizzare, ad esempio, un pretty printer gratuito, multipiattaforma e opensource come AStyle.

A tale scopo si è preparato un file di configurazione apposito, qui allegato, rispondente a criteri generali di stile decoroso, buon ordine e leggibilità: per utilizzare tale file con la propria installazione di AStyle è necessario e sufficiente copiarlo con il nome di "astylerc" (privo di estensione) nella medesima directory nella quale risiede il sorgente C/C++ da formattare.
Una buona occhiata alla documentazione dell'utility fugherà qualsiasi ulteriore dubbio.

#astylerc
# C source code format options for high readability
--style=ansi
# Make sure no tab is used, decent indentation size
--indent=spaces=4
# Bulk options: let's cut it short...
-bCSKNLwfdUpV

In breve, tali opzioni impongono ad AStyle di eliminare ogni carattere di tabulazione convertendolo in una serie di esattamente quattro spazi, e più in generale di seguire lo stile ANSI K&R, soprattutto a livello di parentesi graffe, indentando praticamente ogni costrutto del linguaggio (eccetto le direttive di preprocessore), eliminando gli spazi superflui entro le parentesi tonde, e pochi altri dettagli di pretty printing.

Si rimanda alla documentazione di AStyle - un tool peraltro utilizzabile anche con altri linguaggi di programmazione - per ulteriori approfondimenti.