フロッグマンエンジン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.クリーンコードを宗教的に実践しない。同僚が読みやすく理解しやすいように、冗長なコード、過剰に設計されたコード、複雑なコードを書かないようにする。