プログラマ専用SNS ミクプラ

コード:

void A()
{
  ...

  //↑ここまでで，何をやっていたのか　というのを読み解いた結果を　ここに要約などをコメントとして書く．
  //（自身の記憶力などを過信せず，後から見返したときに十分な助けとなるように書く）

  B();  //B()の中でも同じことやる

  //B()を呼んだことで，何をしたことになるのか，を同じようにここに書く

  ...
}

コード:

void 関数() {

	// なになにをする関数。まず何を何して何する。
	// つぎに...とする。
	// これはｘｘｘを考慮するためである　←単に挙動だけでなく、「意図」を書くのも大事
	
	int xxxx;
	xxxxxxx();

	xxx=xxxxxxx();
	xxxxxxx();
	xxxxxxx();
	for(xxx=xxx;xxx<xxx;xxx) {
		xxxxxxx();
		xxxxxxx();
	}

	// 最後に、xxxの場合はxxx、
	// xxxの場合はxxxを実施する。

	if(!xxxxxx()){
		xxxxxxx();
	}
	if(xxx<=xxx && xxx<=xxx){
		xxxxxxx();
	}
	
}

コード:

void 関数() {

	// なになにをする関数。まず何を何して何する。
	int xxxx;
	xxxxxxx();

	// つぎに...する。
	xxx=xxxxxxx();

	// ｘｘの処理を行うことでｘｘｘｘとする。ｘｘｘのためである。　　　　←意図も書いてはいるけど、他のコメント行との見た目の差異がない。
	xxxxxxx();

	// つぎに...する。
	xxxxxxx();
	
	// ｘｘｘｘｘｘを繰り返し...
	for(xxx=xxx;xxx<xxx;xxx) {
		// ｘｘｘにする。　　　　　　　　　　　　←コメントの文脈がネストをまたぐ。
		xxxxxxx();
		// ｘｘｘにする。
		xxxxxxx();
	}

	// 最後に、xxxの場合は...
	if(!xxxxxx()){
		// xxxを実施する。　　　　　　　　　　　　←コメントの文脈がネストをまたぐ。
		xxxxxxx();
	}

	// またxxxの場合は...
	if(!xxxxxx()){
		// xxxを実施する。　　　　　　　　　　　　←コメントの文脈がネストをまたぐ。
		xxxxxxx();
	}
}