Com fer servir clang-format
ClangFormat és un
programa que formateja codi C++ amb un
estil configurable,
especificat en el fitxer .clang-format. Està instal·lat a les
aules informàtiques i també és el programa que s'instal·la
implícitament quan s'usa
l'extensió de C++ de Visual Studio Code.
A PRO1 farem servir un format estandaritzat per a tothom, professorat i alumnat. El fet de formatar el codi automàticament permet no haver de dedicar temps a fer-ho a mà i gaudir d'un format homogeni en tot el codi de l'assignatura, independentment de qui l'hagi escrit.
La configuració estàndar a PRO1 és la que es pot descarregar des d'aquest botó:
Com configurar clang-format
clang-format busca un fitxer anomenat .clang-format a la
carpeta on se situa el fitxer .cpp que es vol formatar. Si no
el troba, mirarà a la carpeta pare, i així successivament fins
arribar a la carpeta arrel del sistema de fitxers. Aquesta regla
permetria tenir diferents estils en funció de la carpeta a on
s'estigui.
El nom, començant amb ".", indica que el fitxer és ocult (a
Linux i Mac, perquè a Windows ocultar fitxers depèn dels atributs
i no del nom). Això vol dir que, si esteu a Linux o a Mac, per
veure el fitxer .clang-format cal mostrar els fitxers ocults
expressament (al terminal: "ls -a").
A més, el botó de descàrrega de clang-format descarrega un
fitxer que no porta el "." com a prefix, i per tant cal
canviar-li el nom.
Configuració per a PRO1
Per a PRO1, el més recomanable és:
- Descarregar el fitxer (la descàrrega s'anomena
clang-format, sense punt). - Canviar-li el nom a
.clang-format. - Posar-lo a la carpeta que englobi tots els fitxers de codi de PRO1.