C言語 ソースコードの書き方【サンプルフォーマットを公開】

こんにちは、ナナです。

C言語のプログラムは「ソースコード（ソースファイルとも呼ぶ）」と「ヘッダファイル」の２種類で構成されます。

それぞれのファイルには「どこに何を書くべきか？」というのが暗黙的に決まっており、このルールを知らないと予期せぬビルドエラーに悩まされることになります。

本記事ではソースコードには、いったい何を書くべきかに焦点を当てて解説します。

本記事では次の疑問点を解消する内容となっています。

では、ソースコードの書き方を学んでいきましょう。

ソースコードに書かれるべき部品とは

ソースコードにはいったい何をどこに書くべきなのかを示しましょう。

ソースコードの構成部品

ソースコードは次の構成部品で定義します。

いくつかの部品はヘッダファイルにも登場したものが含まれていますね。

部品を配置してよいかの判断リスト

次のリストは、C言語における主な部品一覧です。ソースコードに書くものは『〇』のものです。

※「△」の項目はソースコードに記述するケースもある部品です。

ソースコードの定義例と書き順について

具体的なソースコードのプログラム例を示しましょう。

ソースコードのサンプル定義例

このソースコードの定義例は、私が実際に開発するときの基本フォーマットです。

main.c

#include <stdio.h>
#include <string.h>
#include "sub.h"

//------------------------------------------------
//  非公開マクロ定義
//------------------------------------------------
#define D_SUB_ID    (50)

//------------------------------------------------
//  グローバル変数定義
//------------------------------------------------
static long gSystemflg = 0;

//------------------------------------------------
//  概　要：サブ情報のプリント出力
//  引  数：info    サブ情報
//  戻り値：正常／異常
//------------------------------------------------
int subPrint(S_SUBINFO info)
{
    printf("%s %d", info.moji, info.num1);
    return 0;
}

//------------------------------------------------
//  概　要：システムのエントリーポイント
//  戻り値：正常／異常
//------------------------------------------------
int main(void)
{
    S_SUBINFO info;

    gSystemflg = 1;

    info.num1 = D_SUB_ID;
    strcpy_s(info.moji, D_SUB_NUM, "Hello");

    subPrint(info);
    return 0;
}

プログラム内容自体に意味はありませんので、解析する必要はありません。各部品がどのような書き方でどの位置に配置されるかに着目してみてください。

各部品の配置順について

各部品は次の順序で配置しましょう。

関数定義の中でグローバル変数を参照するため、グローバル変数の定義を先に書きます。

関数ヘッダのコメント

関数定義の直前に記述してあるコメントは、「関数ヘッダ」と呼ばれるコメントです。

このように関数の概要や引数・戻り値に関する情報をコメントとして記載しておくことで、第３者がプログラムを読んでも理解しやすいように補足しています。

//------------------------------------------------
//  概　要：サブ情報のプリント出力
//  引  数：info    サブ情報
//  戻り値：正常／異常
//------------------------------------------------
int subPrint(S_SUBINFO info)

実際の開発では関数が数百、数千といった規模になることも珍しくありません。このようにコメントを残すことで可読性やメンテナンス性をよくしていきます。

ソースコードにグローバル変数と関数定義は置きましょう

ここまで関数定義に関しては、ソースコードに書いてきたため迷わないと思います。

しかし、グローバル変数の定義となると「どこに書けばいいの？」とわからなくなる方がいます。

この時についやってしまうのが、「ヘッダファイルにグローバル変数を定義」してしまうことです。

グローバル変数の定義はヘッダファイルに書いてはなりません。

これには明確に書いてはならない理由があるのです。それでは理由を説明していきましょう！

グローバル変数をヘッダファイル書くといったい何が起きるのか？

もしも、グローバル変数の定義をヘッダファイルに記述するとどうなるのかを見てみましょう。

とあるヘッダファイルが、複数のソースコードからインクルードされることは普通のことです。

ヘッダファイルにグローバル変数の定義があると、システム全体で同一名称のグローバル変数がいくつも定義されてしまい「多重定義」となる問題が発生します。

このルールは関数定義にも当てはまります。関数定義はヘッダファイルに書いてはならないのです。

この問題は多重インクルード防止では対策できません。勘違いしないようにしましょう。

ソースコードに「マクロ定義」「型定義」「プロトタイプ宣言」を書くケースとは

これらの要素を、「ヘッダファイル」「ソースコード」のどちらに書くかという判断は『外部に対して公開すべき情報なのか』という観点が必要となります。

まずは、「機能を外部公開する」という観点を手に入れましょう。

関数サービスを「外部のソースコードへ提供する」という捉え方

C言語に限らずですが、プログラムというのは「機能」という単位を、１つのソースコードで管理するのが一般的です。

次の図は「機能A」「機能B」が「機能C」のサービスを利用している様子を示しています。

つまり、「機能C」は外部の「機能A」と「機能B」へサービスを提供しているとも言えます。

プログラムで、このサービス提供を実現するために「機能A」と「機能B」では、「機能C」が定義する関数プロトタイプ宣言が最低限必要となります。

これを実現するのが、ヘッダファイルによるサービス情報のインクルードなのです。

とある機能を使いたいと思ったら、対象機能のヘッダファイルをインクルードする。これがシステムを構築する基本構造です。

外部に提供したくない情報はソースコードで定義せよ

ヘッダファイルの役割とは、外部からサービスを利用するための情報提供です。

逆に言うと、

外部に公開する必要のない情報をヘッダファイルに書いてはなりません。情報というのは可能な限り、小さく閉じておくのが良いのです。

具体的にプログラムで「外部公開」「外部非公開（内部）」の例を示しましょう。

「D_NUM」というマクロ定義は、sub.cのソースコード内でしか使用しない定義です。そのため、ソースコードで定義を行います。

結論ですが、

ソースコード内に「マクロ定義」「型定義」「プロトタイプ宣言」を記述するケースは、対象ソースコード内でしか使用しない情報を定義する場合です。