Wikibooks

C言語/記法

< C言語
制御文 C言語
記法 		データ型と変数

記法は、プログラムを書く際のルールやスタイルを指します。一貫性のある記法を守ることで、コードの可読性と保守性が向上します。また、チーム開発では共通の記法を使うことで、他のメンバーがコードを理解しやすくなります。この章では、C言語の基本的な記法やコーディング規約について学びます。

基本構文

編集

プログラムの基本構造

編集

C言語のプログラムは、関数の集合体です。最も基本的な構造は以下のようになります。 

#include <stdio.h>

// 関数プロトタイプ宣言
void hello(void);

int main(void) {
    hello();
    return 0;
}

// 関数定義
void hello(void) {
    printf("Hello, World!\n");
}
  • インクルードガードとヘッダーファイル：プログラムの再利用性を高め、重複定義を防ぐためにヘッダーファイルを使用します。
  • main関数の役割：プログラムのエントリーポイント（開始点）であり、必ず1つ存在します。
  • 関数とプロトタイプ宣言：関数を使う前に、そのプロトタイプを宣言することで、コンパイラに関数の存在とシグネチャー（引数と戻値の数と型）を知らせます。

変数と定数

編集

変数はデータを格納するために使用され、定数は変わらない値を示します。 

int main(void) {
    int num = 10; // 変数の宣言と初期化
    const float pi = 3.14; // 定数の定義
    #define MAX 100 // 定数の定義（プリプロセッサ指令）
    
    printf("num: %d, pi: %.2f, MAX: %d\n", num, pi, MAX);
    return 0;
}
  • 変数の宣言と初期化：変数は宣言と同時に初期化できます。
  • データ型と型修飾子：int, float, doubleなどのデータ型やconst, volatileなどの修飾子があります。
  • 定数の定義：定数は変更されない値で、constキーワードや#defineプリプロセッサ指令を使用します。

演算子

編集

C言語にはさまざまな演算子があります。

  • 算術演算子：+, -, *, /, %
  • 関係演算子：==, !=, >, <, >=, <=
  • 論理演算子：&&, ||, !
  • ビット演算子：&, |, ^, ~, <<, >>
  • その他の演算子：=, +=, -=, *=, /=, %=, ? :（条件演算子）
#include <stdio.h>

int main(void) {
    int a = 5, b = 10;
    int sum = a + b; // 算術演算子
    int isEqual = (a == b); // 関係演算子
    int logicalAnd = (a && b); // 論理演算子
    int bitwiseAnd = (a & b); // ビット演算子
    int max = (a > b) ? a : b; // 条件演算子
    
    printf("sum: %d, isEqual: %d, logicalAnd: %d, bitwiseAnd: %d, max: %d\n", sum, isEqual, logicalAnd, bitwiseAnd, max);
    return 0;
}

スコープと有効範囲

編集

変数のスコープは、その変数が有効な範囲を指します。C言語にはローカル変数とグローバル変数があります。

  • ローカル変数：関数やブロックの内部で宣言され、その範囲内でのみ有効です。
  • グローバル変数：関数の外で宣言され、プログラム全体で有効です。
  • 変数の寿命：変数の寿命はそのスコープに依存します。ローカル変数は関数やブロックが終了すると破棄されますが、グローバル変数はプログラムが終了するまで存在します。
#include <stdio.h>

int globalVar = 100; // グローバル変数

void func(void) {
    int localVar = 50; // ローカル変数
    printf("localVar: %d\n", localVar);
}

int main(void) {
    func();
    printf("globalVar: %d\n", globalVar);
    return 0;
}

コメントの記法

編集

コメントは、コードに説明を追加するために使用します。コメントはコンパイルされず、プログラムの動作に影響を与えません。

  • シングルラインコメント：// から行の終わりまでがコメントになります。
  • マルチラインコメント：/* と */ の間のすべてがコメントになります。
#include <stdio.h>

int main(void) {
    // これはシングルラインコメントです
    printf("Hello, World!\n"); /* これはマルチラインコメントです */
    return 0;
}

コメントのベストプラクティス

編集
  • 明確で簡潔なコメントを書く。
  • コードが何をしているかだけでなく、なぜそうしているのかを説明する。
  • 過度なコメントを避ける。

コードのインデントとスタイル

編集

インデントはコードの構造を視覚的に分かりやすくするために重要です。

  • インデントの重要性：適切なインデントは、コードの可読性を向上させ、エラーを減少させます。
  • インデントスタイル：代表的なスタイルにはK&Rスタイル、Allmanスタイルなどがあります。
// K&Rスタイル
#include <stdio.h>
int main(void) {
    int i;
    for (i = 0; i < 10; i++) {
        printf("%d\n", i);
    }
    return 0;
}

// Allmanスタイル
#include <stdio.h>
int main(void)
{
    int i;
    for (i = 0; i < 10; i++)
    {
        printf("%d\n", i);
    }
    return 0;
}
  • 空白と改行の使い方：コードを読みやすくするために、適切な場所で空白や改行を使用します。

名前付け規則

編集

適切な名前付けは、コードの可読性と保守性を向上させます。

  • 変数名、関数名、定数名の命名規則：意味のある名前を付け、一貫した命名規則を使用します。
  • キャメルケースとスネークケース：キャメルケース（例：myVariable）やスネークケース（例：my_variable）を使用します。
  • 名前の衝突を避ける方法：スコープを適切に管理し、プレフィックスを使用するなどして名前の衝突を避けます。
#include <stdio.h>

int myVariable = 10; // キャメルケース
int my_variable = 20; // スネークケース

void printValue(int value) {
    printf("Value: %d\n", value);
}

int main(void) {
    printValue(myVariable);
    printValue(my_variable);
    return 0;
}

関数の記法

編集

関数は、特定のタスクを実行するコードの塊です。

  • 関数の定義と呼び出し：関数を定義し、それを呼び出すことでコードを再利用できます。
  • 関数の引数と戻り値：関数に引数を渡し、戻り値を返すことができます。
  • 再帰関数とその注意点：再帰関数は自分自身を呼び出す関数です。無限ループに注意します。
#include <stdio.h>

int factorial(int n) {
    if (n <= 1) {
        return 1;
    } else {
        return n * factorial(n - 1);
    }
}

int main(void) {


    int num = 5;
    printf("Factorial of %d is %d\n", num, factorial(num));
    return 0;
}

プログラムの構造化

編集

大規模なプログラムでは、コードをモジュール化し、複数のファイルに分割することが重要です。

  • モジュール化とファイル分割：機能ごとにコードを分割し、モジュール化します。
  • ヘッダーファイルの使い方：共通の関数プロトタイプや定数をヘッダーファイルにまとめます。
  • インクルードガードの重要性：重複定義を防ぐために、ヘッダーファイルにはインクルードガードを使用します。
example.h
#ifndef EXAMPLE_H
#define EXAMPLE_H

void printMessage(void);

#endif
example.c
#include <stdio.h>
#include "example.h"

void printMessage(void) {
    printf("This is a modular program.\n");
}
main.c
#include "example.h"

int main(void) {
    printMessage();
    return 0;
}

プリプロセッサディレクティブ

編集

プリプロセッサディレクティブは、コンパイル前にコードを処理する命令です。

  • #include：外部ファイルを読み込む。
  • #define：定数やマクロを定義する。
  • #ifdef, #ifndef, #endif：条件付きコンパイルを行う。
#include <stdio.h>

#define PI 3.14

int main(void) {
    printf("Value of PI: %.2f\n", PI);
    return 0;
}

プリプロセッサディレクティブの役割と注意点

編集
  • 過度な使用を避ける：可読性が低下する可能性があります。
  • 一貫性を保つ：コードの一貫性を保つために適切に使用します。

デバッグとテストのための記法

編集

デバッグとテストは、バグを見つけ出し、プログラムの信頼性を高めるために重要です。

  • デバッグ用のプリント文：プログラムの動作を確認するためにprintf文を使用します。
  • アサーション（assert）の使用：プログラムの前提条件をチェックし、条件が満たされない場合にプログラムを停止します。
  • テストコードの書き方：プログラムの正確性を確認するために、テストコードを書きます。
#include <stdio.h>
#include <assert.h>

void testFunction(int value) {
    assert(value > 0); // valueが0より大きいことを確認
    printf("Value is %d\n", value);
}

int main(void) {
    testFunction(5);
    // testFunction(-1); // これはassertに引っかかる
    return 0;
}

まとめ

編集

この章では、C言語の記法について学びました。一貫性のある記法を守ることで、コードの可読性と保守性が向上します。以下のポイントを常に意識しましょう：

  • 明確で一貫した命名規則を使用する。
  • 適切なインデントとスタイルを守る。
  • コメントを適切に使い、コードを説明する。
  • プログラムをモジュール化し、ファイルを分割する。
  • デバッグとテストを通じて、プログラムの信頼性を高める。

附録A: コーディングスタイルガイド

編集

以下は、一貫性のあるコーディングスタイルガイドの例です。

  • インデント：スペース4つまたはタブ1つを使用。
  • 命名規則：キャメルケースを関数名に、スネークケースを変数名に使用。
  • コメント：関数の説明、複雑なロジックの説明、TODOリストなどに使用。
  • 空白と改行：適切に使用してコードを見やすくする。

スタイルチェッカーの紹介と使い方

編集
  • スタイルチェッカー：ClangFormat、Astyleなどのツールを使用して、コードのスタイルを自動的にチェックし、整形します。
  • 使用方法：ツールの設定ファイルをプロジェクトに追加し、コマンドラインやIDEのプラグインを使用してコードを整形します。


  制御文 C言語
記法 		データ型と変数  
"https://ja.wikibooks.org/w/index.php?title=C言語/記法&oldid=251683" より作成