2000年7月15日更新(新規作成)
  関谷トップページへ

C言語のソースプログラムの様式について

  2000.5.15, 7.12 KPC 情報技術科 関谷

  
分かりやすい・読みやすいC言語のプログラムを作るために、ソースプログラムの様式を以下のようにお勧めします。

1.コメントを入れる。
1.1 ファイル名、作成日、作成者(先日の岩元先生のアドバイス)
1.2 日本語のプログラム名・概要(テキストのlist n-mm の次の文字列など),考察(注意することなど)
   
1.3 プログラム仕様
・入力
・処理(アルゴリズム-処理手順、プランなどとも呼ぶ)
・出力

(この書き方は、ブロックなどのレベルに応じて、番号を取ると共に、字下げをする。
 変数名は、日本語名とプログラムでの変数名を続けて書く。2000.7.12
例[double lagrangian(int m, double x[], double f[], double xq)]
    ラグランジュ関数(補間多項式の和を求める)
1)補間値fxqを0.0とする。
2) 項番号iを初期値0とし、m-1以下のとき、項の計算を繰り返し、終端でiを+1する。
	2.1)分子bunsi、分母bunbo(積)の初期値を1.0とする。
	2.2)積のループ添え字jを初期値0とし、m-1以下のとき、積の計算を繰り返し、終端でjを+1する。
		2.2.1)j!=iのとき、
			2.2.1.1)分子、分母のj変数分の積をそれぞれ求める。
	2.3)第i項の値fxqi=bunsi/bunbo*f[i]を計算する。
	2.4)第i項の値fxqiを補間値fxqに加える。
3)補間値fxqを返す。


1.4 ソースのブロックや行に対して、右側に日本語で説明する。
(テキストの例では、水色で説明してある部分など)

(注)秀丸で設定:タブキーは、4文字の設定。行のカウントはエディタ的、インデントは、C言語。

1,5 実行結果を貼り付ける。あるいは、リダイレクトでアペンド(追加)する。
 リダイレクトは、テキストのp.213-215を参照のこと。>>はアペンドで、ファイルの最後から追加する。なければ新規に作る。


2.プログラム名やプロンプト(入力促進文)、入力データ(チェックプリント)を表示する。
2.1 プログラム名などのタイトル:これは、誰が、どんなプログラムを実行しているかを分かるようにするためです。

2.2 プロンプト(入力促進文):なにを入力するのかを、明確にするためです。

2.3 入力データ(チェックプリント):どんなデータとして読み込んだかを表示する。
(正しく、データが読み込まれているか。今後の問題では、それがデバッグの助けになる。)

以下に、例題ex210.cの例を付けます

/* list 2-10 ex210.c, 2000.5.12, KPC sekiya, 入門C言語、新版p.66-68*/
/* 変数の値を表示しながらカウントアップする */

/* 考察
1.  
2.

*/

/* プログラム仕様
・入力:なし
・処理:1から2までを表示する(while)
・出力:0,1,2,
*/

#include <stdio.h>

main()
{
	int i = 0;

	printf("list 2-10 ex210.c, 2000.5.12, KPC sekiya\n");
	printf(" 変数の値を表示しながらカウントアップする\n");

	while (i < 3) {		/* 条件式(i<3)が真の間 ブロックを繰り返す*/
		printf("%d, ", i);
		i++;
	}
	printf("\n");
}
/* 実行結果
list 2-10 ex210.c, 2000.5.12 KPC sekiya
 変数の値を表示しながらカウントアップする
0, 1, 2,
*/