Androidコード仕様まとめ

2691 ワード

image.png
githubの優れたプロジェクトコードを見るたびに、耳を抜くよりも楽しむことができます.コードを書くのは文章を書くのと同じで、コードを書くときの開発者の顔の値は、いわゆるブスがいないので、怠け者だけで、きれいなコードも私たちが心を込めて飾る必要があります.簡潔で規範的なコードは個人に対して、チームに対して、次のコードの接盤者に対して、1種の責任で、1種の専門の体現でもあります.
ネーミング仕様:
  • 類の命名:アルパカ法を使用するとともに、クラスの役割に応じてAndroid関連の命名規則を導入する必要があり、クラスのタイプを接頭辞または接尾辞として使用する必要がある.例:Activity類:xxxActivity Fragment類:xxxFragment Service類:xxxServicesツール類:xxxUtil Adapter類、xxxAdapterベース類、Basexxx
  • レイアウトファイル命名:レイアウトファイル命名規則「接頭辞_論理名」方式、単語全小文字、例:Activityレイアウトファイル命名:activity_xxx Fragmentレイアウトファイル命名:fragment_xxxカスタムコントロールレイアウトファイル命名:view_xxx Dialogレイアウトファイル命名:dialog_xxxリスト項目レイアウトファイル名:item_xxx
  • リソースファイル命名:リソースファイル命名規則「接頭辞モジュール名機能名」方式、単語全小文字、例:私の個人設定textview、tv_me_settingログインボタン、btn_loginアイコンの名前はicを接頭辞とし、ic_のような形をしている.xxx背景画像の名前はbgを接頭辞とし、bg_のような形をしている.xxx背景スタイルshape形はshape_xxxバックグラウンドセレクタselector形例えばselector_xxx
  • ネーミング構造
  • 列挙定数はカンマで区切られ、改行はオプション:
  • public enum NetWorkState {
        WIFI,MOBILE,NONE;
    }
    
  • は、毎回1つの変数のみを宣言します.int num、maxなどの宣言変数を組み合わせないでください.これは読書に影響します.
  • データ初期化:ブロック構造、例えば
  • と書くことができる.
    new int[] {
            0, 1, 2, 3 
    }
    new int[] {
            0,
            1,
            2,
            3
    }
    
  • 変数と定数変数名の命名には、アルパカ法lowerCamelCaseが使用されます.定数名は大文字で、単語は下線で分割されます.例えばpublic static final int REQUEST_OK = 200.
  • 一時変数変数i,j,kは、通常、ループカウントに用いられる.変数m,nは通常整形に用いられる.c,d,eは通常文字型に用いられる.
  • 常用英語単語略語:
  • 名前
    略語
    icon
    ic
    average
    avg
    background
    bg
    delete
    del
    document
    doc
    error
    err
    increment
    inc
    infomation
    info
    initial
    init
    image
    img
    length
    len
    library
    lib
    message
    msg
    password
    pwd
    position
    pos
    string
    str
  • ピンインで命名しないで、英語の単語を知らないですぐに翻訳を使います.

  • コード表記規範:
  • は括弧:if,else,forなどの文を括弧と一緒に使用することが多く、1つの文だけでも括弧を付ける必要があります.
  • if(allowed)
        todo();
    else
        back();
    

    このように書くことをお勧めしません.そうすれば、人を誤解させる可能性があります.正しい方法は次のとおりです.
    if(allowed){
        todo();
    }else{
        back();
    }
    
  • 行あたりの文字数は80~100文字に制限されています.
  • 空白の使用:記号の間にスペース間隔を適用します.1つのコード内では、すべて押し合わないで、論理に従ってグループ化し、空の行で隔てて、論理をより明確にしなければならない.
  • 修飾子の順序:クラスとメンバーの修飾子が複数存在する場合、public protected private abstract static final transient volatile synchronized native
  • メソッドのコメント:
  • /**
         *     
         * @param     
         * @return      
         * @author      
         */
    private void function(){
    }
    
  • クラスのコメント:クラスの作成時に作成者、作成時間、連絡方法、クラス機能などの情報
  • をマークします.
    /**
     * Created by libo on 2017/12/25.
     * email:
     *   
     */
    

    この文章は総括し続け、更新し続けている.