マイコーディング：可読性のために

MyCodingRule_Readability.md

• ◎ 丁寧なコメントを長々と書くぐらいなら、リファクタリングを検討する。

• ◎ 後で見直したいコード中のメモは「@todo_xxxx」のような書式に統一する。

  • 備忘録としても使えるし、他の人がコードを見た時わかりやすいので

• ○ ファイルの先頭には、どういうファイルなのか、をコメントで説明を書く

• △ 関数や定数には、必ずコメントを書く。

  • 関数の場合、処理内容、引数、返り値の説明をつける（引数、返り値の説明はわかりにくい場合のみで可）
  • 基本、関数名や引数名の名前から、機能を判断できるようにするのが望ましい

/**
 * 得点を算出する
 * @param   int try_count
 */
int
calcScorePoint(int try_count)
{ 
}