クラス名などのルールチェックを行います。
正規表現で有効なパターンを設定します。
抽象(abstract)クラスの命名ルールを設定します。
デフォルトは ^Abstract.*$|^.*Factory$ です。
個人的には、それほどお勧めしません。
抽象クラスだからといって特定の命名ルールを定めると
後々のリファクタリング処理でクラス名を変更する必要が出てきてしまいます。
インターフェイスの先頭に「I」を付けるのも、同様の理由からお勧めしません。
このパターンに当てはまるクラス名の例を挙げます。
AbstractCondition NameFactory
定数（staticかつfinal）の命名ルールを設定します。
デフォルトは ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ です。
これはほとんど全ての言語で適用されているルールなので
特に問題は無いでしょう。
このパターンに当てはまる定数名の例を挙げます。
KEY_1 MAGIC_NUMBER
このパターンに当てはまらない定数名の例を挙げます。
_ABC instance LOT_ NUMBER__50
finalローカル変数の命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
変数の命名ルールには、いくつかのパターンがあります。
例えばハンガリアン記法では、変数名の最初に型の略称(str〜など)を
付けることが定められています。
Javaなどのオブジェクト指向言語では、これは勧められない手法です。
変数の型はリファクタリングにより変わる可能性が大いにあります。
このとき、変数名をそのままにしてしまうと整合性が取れなくなってしまいます。
変数名は、クラス名と同様その役割からのみ決定すべきです。
finalだから、パラメータだからといった理由で変数名を決定すべきではありません。
ただし一つだけ、守っておくと良いルールがあります。
それは、「コレクションには変数名の最後にsを付ける」というものです。
英語圏の人ならばこれは暗黙の了解なのでしょうが
日本人にはあまりピンと来ない人も多いようです。
コレクションとはリストや配列、セットなど色々な種類があります。
くれぐれも 〜List のような名称は止めておきましょう。
その変数は今後、セットや配列にならない保証がありますか？
このパターンに当てはまる変数名の例を挙げます。
value number1 strTime
このパターンに当てはまらない変数名の例を挙げます。
_number Top str_time 4str
finalでないローカル変数（catchパラメータ変数も含む）の命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
staticでないフィールド（変数）の命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
publicフィールドのチェック有無を設定します。
protectedフィールドのチェック有無を設定します。
package（デフォルト）フィールドのチェック有無を設定します。
privateフィールドのチェック有無を設定します。
メソッドの命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
メソッド名の決定は、プログラムを読みやすくする為に大切な行為です。
名称からその概要が浮かんでくるようなものを心掛けましょう。
パッケージの命名ルールを設定します。
デフォルトは ^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$ です。
このパターンに当てはまるパッケージ名の例を挙げます。
pack1 org._abc jp.Text3
このパターンに当てはまらないパッケージ名の例を挙げます。
Text org.3line
パラメータ（メソッドの仮引数）の命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
static変数の命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
クラスやインターフェイスの命名ルールを設定します。
デフォルトは ^[a-z][a-zA-Z0-9]*$ です。
|
|