プログラムの書き方

書き方の慣習

MMGames

インデント、コメント



関数の書き方


前節で説明したように、C言語はフリーフォーマットなのですが、
だからと言って、皆がバラバラな書き方をしていると、プログラムが読みにくくなります。
その為、ある程度、書き方の慣習が定められています。

始めに作成したプログラムは、全てを1行に詰め込んでいました。

int main(void) {return 0;}
言うまでもなく、この書き方は読みにくい、行儀の悪いプログラムです。
関数は、一般的には、次のような書き方をするのが良いとされています。

int main(void)
{
	return 0;
}
この様な書き方をすれば、関数の始まりと終わりがわかりやすくなります。


インデント


先ほどのプログラムをもう一度見てみましょう。

int main(void)
{
	return 0;
}
return文が、右にずれていることがわかると思います。
これは、インデントと呼ばれる、C言語の特徴的な書き方です。
インデント
階層を表現するために、右にずらして書く方法のこと。
インデントは、階層的な構造を表現するために使われます。
C言語では、{} で囲まれた中の文は、右に少しずらすことが慣習となっています。
このとき、右へのずらしには、タブ(Tab)キーを使用するのが慣習です。
スペースで隙間を作るのではなく、タブキーを使ってずらすようにして下さい。

なお、最近の開発環境やテキストエディタを使用している場合は、
{} を入力した段階で、自動的にインデントする機能がついています。
出来れば、そのようなエディタを使用して、自動的につけさせるのが楽で良いでしょう。
楽をする
プログラマーにとって最も重要なことは、楽をすることです。
とにかく、コンピュータに出来ることは全てコンピュータにやらせるべきです。
雑用はコンピュータに任せ、人間はより創造的な作業に取り組むようにしましょう。


コメント


簡単なプログラムであれば、見ればその内容はすぐにわかるのですが、
複雑なプログラムになると、一見しただけではその内容がわかりません。
プログラムの中に説明を入れておけば、プログラムが読みやすくなります。

C言語には、プログラムに説明を入れておく機能があり、これをコメントと呼びます。

コメント
プログラムの中に書き込んでおく説明文。プログラムの動作には全く影響がない。
C言語では、/* */ で挟むことで、その間をコメントにすることが出来ます。
このコメントは、プログラムの実行には一切影響を与えません。

int main(void)
{
	/* ここがコメント */
	return 0;
}
この様にして、プログラムの中に説明を埋め込むことが出来ます。
繰り返しますが、コメントはプログラムの動作には一切影響を与えません。

コメントは、複数行に書いたり、プログラムのある行に書くことも出来ます。

int main(void)
{
	/*
	これは、これ全部が、
	コメントです。
	*/
	return 0;	/* ここもコメントです */
}
コメントの書き方については、特に統一した慣習などはありません
やたらコメントを書く人もいれば、チョコチョコと書く人もいます。
しかし、全くコメントを書かないのは、規模の大きなプログラムでは問題になります。
実は、自分で書いたプログラムの内容を忘れてしまうことは多いのです。

今後は、サイトで解説するプログラムでは、必要な部分にはコメントをつけます。
あなたも、自分で書くプログラムには、コメントをつけるのが良いと思います。

サイト目次


第0部:プログラム概要編

  1. プログラムとは何か?

2章:プログラムの書き方

  1. 書き方のルール
  2. 書き方の慣習
  3. 練習問題2

3章:画面への表示

  1. 文字列の表示
  2. 改行文字
  3. 練習問題3

6章:キーボードからの入力

  1. 入力用の関数
  2. 入力の恐怖
  3. 練習問題6

9章:回数が決まっている繰り返し

  1. 繰り返しを行う文
  2. ループ動作の仕組み
  3. 練習問題9

10章:回数がわからない繰り返し

  1. 回数不明ループ
  2. 入力チェック
  3. 練習問題10

13章:複数の変数を一括して扱う

  1. 複数の変数をまとめて扱う
  2. 配列の使い方
  3. 練習問題13

20章:複数のソースファイル

  1. 最小限の分割
  2. 分割の定石
  3. 練習問題20