Il presente documento è soggetto a ulteriori revisioni.
Il codice aumenta in modo significativo man mano che un progetto si sviluppa, a seconda dell’obiettivo e del tipo di progetto. Un codice incoerente compromette la leggibilità e la manutenibilità, interferendo con la produttività individuale o del team.
Gli standard di programmazione potrebbero non essere necessari per il codice destinato a un uso una tantum. Seguire una guida di stile di programmazione è necessario per evitare incoerenze nel codice ed evitare di finire nell’inferno del debug.
Il "codice pulito" non esiste ed è una favola, poiché la percezione di cosa sia un codice pulito è soggettiva a livello individuale o di team. L’obiettivo di questo documento è evitare di scrivere codice illeggibile ed evitare di seguire alla lettera il concetto di "codice pulito".
Un esempio semplificato di codice offuscato e profondamente annidato)
#include <iostream>
#include <cstdlib>
void mergeSort(int *arr, int l, int r) {
if (l < r) {
int m = l + (r - l) / 2;
mergeSort(arr, l, m);
mergeSort(arr, m + 1, r);
int n1 = m - l + 1;
int n2 = r - m;
int *L = (int*) malloc(n1 * sizeof(int));
int *R = (int*) malloc(n2 * sizeof(int));
for (int i = 0; i < n1; i++) L[i] = arr[l + i];
for (int j = 0; j < n2; j++) R[j] = arr[m + 1 + j];
int i = 0, j = 0, k = l;
while (i < n1) {
if (j < n2) {
if (L[i] <= R[j]) {
arr[k] = L[i];
i++;
} else {
arr[k] = R[j];
j++;
}
} else {
arr[k] = L[i];
i++;
}
k++;
}
while (j < n2) {
arr[k] = R[j];
j++;
k++;
}
free(L);
free(R);
}
}
(anziché adottarne altre).
Online sono disponibili numerose guide di stile e convenzioni di programmazione in C++ ben documentate, come la guida di stile di Google e lo standard di codifica di Unreal. Nonostante la loro disponibilità, comprendere le ragioni alla base delle regole è di inestimabile valore.
C++ Coding Standards | Pope's Dev Docs