ためになるホームページ お問い合わせ




TOP > Java > Sun Javaコーディング規約
インデント
  • 半角の4個をあける
  • タブは半角8個分にする
  • 開始コメント・パッケージ宣言・import文・インタフェース宣言・クラスの宣言は、インデントしない。
  • 静的変数・インスタンス変数・コンストラクタ・メソッド・それぞれのコメントは、1レベル以下さげてインデントする。
  • コンストラクタ内とメソッド内では、ローカル変数・文・コメントをもう1レベル下げてインデントする。
  • ブロック内の中の文(コメント)は、ネストのレベルごとにもう1レベル下げてインデントする。

  • 行の長さと行の折り返し
  • 1行は最大80行とする。極力、65字以内にすること。1行におさまらない時は、下記のガイドラインに従う。
  • コンマの後ろで折り返す。
  • 演算子の前で折り返す。
  • 折り返した行の2行目以降は、1行目の先頭からタブ1個分下げて揃える。
  • 内側の括弧内の式は途中で折り返さないようにする。

  • 空白行
    下記の場合は、1行空白行を入れる。
  • メソッドの間及び、コンストラクタの間。
  • 最後のインスタンス変数の後ろ。
  • メソッド内のローカル変数と最初の文の間。
  • メソッド内でコードの論理セグメントを分けるとき。
  • 1行コメントまたは、ブロックコメントの前。

  • 空白
    下記の場合は、空白を挿入する。
  • 2項演算子の間
  • 引数リストのコンマの後ろ
  • for文の式の後ろ
  • キーワードと括弧の間
  • キャストの後ろ

  • 中括弧({})の使い方
  • クラス・インタフェース・コンストラクタ・メソッドの左中括弧{は宣言と同じ行の末尾に配置。右中括弧}は新しい行の先頭に単独で配置し、対応する宣言の先頭に合わせてインデントする。
  • フロー制御(if・whileなど)の中括弧は、中括弧を使わなくても済ませられる場合でも、必ず{}を入れること。
  • switch文の中で、break文を含まないcaseブロックの末尾に「/* フォースルー */」と記述すること。

  • コメントについて
  • プログラムの内容を複数の行で説明する必要がある場合は、ブロックコメントを使う。通常は空白行の後に記述する。
  • 1行コメントも空白行の後に、記述する。

  • 宣言の順序
    以下の通りに宣言する。
  • クラスコメント
  • パッケージ宣言
  • import文
  • クラス宣言
  • 静的変数
  • インスタンス変数
  • コンストラクタ
  • メソッド

  • 配置と初期化(メソッド内での注意点)
  • ローカル変数は(可能な限り)他の文よりも前に宣言して初期化する。
  • ブロック変数は(できれば)他のブロック文よりも前に宣言して初期化する。
  • 1行につき1つのメンバーだけを宣言する。
  • 変数のシャドウ化を避ける。

  • 配置と初期化(メソッド内での注意点)
  • パッケージ名は、できれば小文字を使うことが望ましい。
  • クラス名とインタフェース名は、通常は名詞の名前を使う。先頭の文字を大文字にし、複数の単語が含まれている場合は、各単語の先頭の文字も大文字にする。
  • メソッド名は、通常は動詞の名詞を使う。先頭の文字を大文字にし、複数の単語が含まれている場合は、各単語の先頭の文字も大文字にする。
  • 変数名は、メソッドと同じ規則に従う。1文字の名前は、ループ変数などの1文字変数のみに使う。
  • 変数を定数として扱うには、static及びfinalとして宣言しなければならない。定数の名前は全て大文字にし、単語の区切りはアンダースコア(_)を使用しなければならない。






  • Copyright 2007 ためになるホームページ All Rights Reserved.