Frogman Engine C++ プログラミング標準

この文書は今後改訂される可能性があります。

序文

プログラミング標準の必要性。

プロジェクトの目標や種類にもよりますが、プロジェクトが進むにつれてコードベースは大幅に増加します。コードベースに一貫性がないと、可読性や保守性が損なわれ、個人やチームの生産性を妨げる恐れがあります。

一度きりの使用となるコードベースであれば、プログラミング標準は必要ないかもしれません。しかし、コードベースの不整合やデバッグ地獄に陥ることを避けるためには、プログラミングスタイルガイドに従うことが求められます。

クリーンなコードなど存在せず、それはおとぎ話に過ぎません。なぜなら、クリーンなコードという 認識は、個人やチームによって主観的なものだからです。この文書の目的は、読みにくいコードを書かないようにすること、そして「クリーンなコード」を盲信的に従うことを避けることです。

(難解で深くネストされたコードの簡略化された例)

#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);
    }
}

プログラミングスタイルガイドの作成

(他者のものを採用するのではなく)。

GoogleスタイルガイドやUnrealコーディング標準など、よく文書化されたC++プログラミングスタイルガイドや規約がオンラインで多数公開されている。 それらが利用可能であるにもかかわらず、ルールの背後にある理由を理解することは極めて重要である。

参考文献

C++ Coding Standards | Pope's Dev Docs

主なルール

1. 「クリーンコード」を盲目的に実践してはいけません。同僚が簡単に読み、理解できるように、冗長で、過剰に設計された、あるいは複雑なコードは書かないようにしてください。