コーディング規約

鉄則：「書くときのことよりも、読むときのことを考える」

基本的に↑だけ気をつければおkです。

以下、駄文。

命名について

基本方針

• まず命名です。思い浮かばないなら、一旦手を止めて考え直しましょう。「a」とか「k2」とか論外です。
• 名前には意味を持たせるべきです。
  • 良い例：'bookCount' - 本の数を表す変数だとすぐ分かります。
  • 悪い例：'mode', 'flag' - 何のモードなんだか何のフラグなのかはっきり分かりません。
• 名前には一貫性を持たせた方が良いでしょう。
  • 例えば、何かを作るメソッドを作る時は'createXXX()'か'makeXXX()'が考えられます。
  • どちらを使用しても良いですが、プログラム全体で統一を取るべきでしょう。
  • 悩む場合はご相談ください。
• 省略しない。例えば「'Invader'と打つのはメンドイから省略しようぜ！」と考えたとしましょう。
  • 本人であれば問題ありませんが、他人の場合は把握までに時間がかかります。
  • 省略の規則を定める必要性があります('inv'なのか'inb'なのか'ivdr'にするのか決めなきゃならない)

珈琲界でよく使われる命名規則

• クラス名・インタフェース名は、大文字で始めて、単語の区切りを大文字にする
  • 例：'Object', 'JFrame', 'Invader', 'InvaderGroup', 'Detteiu'
• 変数名・メソッド名は、小文字で始めて、単語の区切りを大文字にする（通称「ラクダ」）
  • 例：'width', 'bookCount', 'parseInt()', 'moveRight()'
• 定数は、全て大文字にして、単語の区切りにはアンダースコアを入れる
  • 例：'PI', 'FRAME_SIZE', 'ARRAY_SIZE'
• パッケージ名は全て小文字にする
  • 例：'java.util', 'java.io', 'javax.swing', 'invadergame.spaceobject'

スタイル

インデントについて

インデントにはいくつかのスタイルが存在します。

• その１(Microsoftスタイル)

if (rideOnYoshi == true)
{

   System.out.println("でっていう！");

}
else
{

   System.out.println(".....");

}

• その２(K&Rスタイル)

if (rideOnYoshi == true) {

   System.out.println("でっていう！");

} else {

   System.out.println(".....");

}

Artemisでは基本的にその２を採用します。