ソースコードの記述について |
付属ソースコードの記述、主に命名規則について述べます。
付属ソースコードはsrcフォルダの下にあります。
章、節番号がsrcフォルダの下にあるフォルダの名前に対応しています。
章全体に対応している場合にはChapter(章番号)、
節に対応している場合にはChapter(章番号)_(節番号)となっています。
型名は大文字で開始した単語を連結します。
例:MainParam
定数名は全て大文字で書き、単語間に"_"を挿入します。
例:BUFFER_SIZE
ローカル変数は全て小文字で書き、単語間に"_"を挿入します。
例:max_value
仮引数は全て小文字で書き、単語間に"_"を挿入します。
さらに以下のルールを適用します。
"in_"で開始します。
"out_"で開始します。
接頭辞はつけません。
selfと記述します。
構造体のメンバ変数名は大文字で開始した単語を連結します。
例:MinDepth
ソースコードには、盤面処理、盤面評価等の処理が機能毎にクラスとして記述されています。
クラス関数は以下のように記述します。
"クラス名"_"メンバ関数名"
クラス名とメンバ関数名は大文字で開始します。
複数の単語を並べる場合には単語の頭文字を大文字にして単語を連結します。
例:Board_CountDisks()
クラスに属さない関数は全て小文字で書き、単語間に"_"を挿入します。
例:print_board()
解説中のソースコードは、特に断りがなければ関数または処理全体の追加、変更について記述しています。
部分的な追加、変更を行なう場合にはその部分を赤で強調してあります。