Este documento poderá ser objeto de revisões futuras.
A base de código aumenta significativamente à medida que um projeto se desenvolve, dependendo do objetivo e do tipo do projeto. Uma base de código inconsistente compromete a legibilidade e a facilidade de manutenção, prejudicando a produtividade individual ou da equipa.
As normas de programação podem não ser necessárias para bases de código de utilização única. É necessário seguir um guia de estilo de programação para evitar inconsistências na base de código e entrar no «inferno da depuração».
O código limpo não existe e é um mito, porque a perceção de código limpo é subjetiva para indivíduos ou equipas. O objetivo deste documento é evitar escrever código ilegível e evitar seguir religiosamente o código limpo.
Um exemplo simplificado de código ofuscado e profundamente aninhado)
#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);
}
}
(em vez de adotar outros).
Muitos guias de estilo e convenções de programação em C++ bem documentados, como o guia de estilo do Google e o padrão de codificação Unreal, estão disponíveis online. Apesar da sua disponibilidade, aprender as razões por trás das regras é inestimável.
C++ Coding Standards | Pope's Dev Docs