日常的に遭遇する符号化規範を蓄積し、良好な符号化習慣を継続的に更新する...

ネーミングの問題

コード時にクラス、方法、変数、常亮命名法に従うべき:その意味を直感的に表現することができる!

アルパカ命名法:書くとき、各単語の頭文字が大文字になります.(大アルパカ小アルパカも全アルパカも自分の名前です)

アルパカ:単語の頭文字はすべて大文字でなければなりません.例えば、UpperCamelCase

アルパカ:最初の単語は全部小文字で、後続のすべての単語は頭文字が大文字です.例:lowerCamelCase

オールアルパカ:すべての単語が大文字で、単語の間に「」区切る.例えば:CAMEL_CASE

ハンガリー命名法:先頭アルファベットは変数タイプの略で、タイプ+アルパカ峰.例えば:int iStudentAge = 0；

クラスの名前:

クラスの命名はアルパカの命名規則に従い、クラスの役割と分類を明確に表現する.

機能クラスとインタフェースクラス:このような一般的なクラスは、アルパカの命名規範に従い、明確なクラスの機能を表現すればよい.

抽象クラス:AbstractまたはBaseで始まる.例えば、AbstractPerson活BasePerson

異常クラス:Exceptionで終わります.例:NoName Exception

インタフェース実装クラス:[インタフェース名]+Implで終わる.例えば、MusicProvider->MusicProviderImpl

テストクラス:テストするクラスの名前で始まり、Testで終わります.例えば:MusicProviderImplTest

変数名:

変数の命名はハンガリーの命名法に従う.しかし、意図的に使う必要はありません.以下の点に注意してください.

グローバル変数とレイアウト変数の区別:グローバル変数はmで始まるのが望ましい.局所変数は意味を示すだけでよい.

静的変数:sで始まります.

定数は全アルパカで命名された.

boolean値の変数は、簡単にisで始まるのではなく、論理を示すことが望ましい.例えば:boolean studentIsNoName = true;

メソッドの名前付け

方法の命名はアルパカの峰に従い,方法の機能を明確に表現することを求めた.

単一オブジェクトを取得する方法はgetをプレフィックスとする.getName()

複数のオブジェクトを取得する方法はlistを接頭辞とする.listName()

統計値を取得する方法はcountを接頭辞とする.countStudent()

挿入方法はaddまたはinsertをプレフィックスとする.addStudent(Student student)

削除の方法はremoveまたはdeleteで接頭辞をします.removeStudent(Student student)

修正方法updateまたはchangeをプレフィックスupdateStudent(Student student ,String name)

とする

ブール値を判断する方法は、isを接頭辞isEmpty();

と命名する.

オブジェクトを特定のタイプに変換する方法は、toを接頭辞として命名すべきtoString()

である.

public class Study {
    private int mAge = 0;
    private String mName = "";
    private int mID = 0;
    private final int FULL_SCORE = 100;

    public Study(int age, String name, int id) {
        mAge = age;
        mName = name;
        mID = id;
    }

    public int getScore(int id) {
        int score = 0;
        if (id == 100) {
            score = FULL_SCORE;
        }
        return score;
    }
}

コードの成功は最終的な目的ですが、プログラマーの基本的な素養を維持し、少なくとも自分のコードを論理的により明確にし、分かりやすくしなければなりません。芸術を追求する道で、私も絶えず勉強しています。