Android開発仕様とインターフェース仕様

  • AS仕様
    • 開発には最新の安定したIDEを使用してみてください
    • .java、.xml、その他のファイルを編集したら、必ずフォーマット、フォーマット、フォーマットを行ってください(チームにパブリックスタイルパッケージがある場合は、それに従ってください。それ以外の場合は、ASのデフォルトテンプレートを一律に使用してください)
    • 重複するインポートを削除して警告を減らし、Ctrl + Alt + Oのインポートの最適化(設定->キーマップ->インポートの最適化)ショートカットキーを使用します
  • 命名規則  
    • コード内の命名は、ピンインと英語の組み合わせを使用することを固く禁じられており、中国語を直接使用することは許可されていません。正しい英語のスペルと文法は、読者を理解しやすくし、あいまいさを避けることができます
    • 注:純粋なピンインの命名でさえ、避けるべきです。ただし、英語でalibaba、taobao、youku、およびhangzhouなどの国際名は同じと見なすことができます。
  • コードスタイル仕様
    • 標準のブレーススタイル{}を使用します。左ブレースは1行を占めず、前のコードと同じ行にあります
    • 関数パラメーターの順序:最初のパラメーターとしてコンテキストが最適
    • 文字列定数の名前と値
      • static final String PREF_EMAIL = "PREF_EMAIL";
      • static final String BUNDLE_AGE = "BUNDLE_AGE";
      • static final String ARGUMENT_USER_ID = "ARGUMENT_USER_ID";
    • アクティビティとフラグメントのパラメータを渡す:アクティビティまたはフラグメントが開始するためにパラメータを渡す必要がある場合、それを開始または作成するためのパブリック静的関数を提供する必要があります
    • 行の長さの制限:コード内のテキストの各行の長さは100文字を超えてはなりません。
  • リソースファイル仕様の命名規則:タイプ{_module name} _logical name
  • 統一バージョン仕様
    • Androidの開発には、compileSdkVersion、minSdkVersion、targetSdkVersion、サードパーティのライブラリに依存するプロジェクトのバージョンなど、さまざまなバージョンがあります。モジュールや開発者によってバージョンが異なるため、統一されたバージョン仕様ファイルが必要です。

    • 複数のシステムレベルのアプリケーションを開発している場合、複数のアプリケーションが同じsoライブラリを同時に使用するときは、soライブラリのバージョンが同じであることを確認する必要があります。そうでない場合、アプリケーションがクラッシュする可能性があります。

  • サードパーティライブラリの仕様
    • チームが最近の新しいテクノロジーを使用できることを願っています。オープンソースライブラリの選択では、通常、より安定したバージョンを選択する必要があります。Retrofit、RxAndroid、OkHttp、Glide / Fresco、Gson / Fastjson、EventBus / AndroidEventBus、GreenDaoなど
  • アノテーション仕様
    • クラスのコメント:各クラスの完了後、著者の名前と連絡先情報のメモが必要であり、彼らは自分のコードを担当します。

    • メソッドコメント:各メンバーメソッドのメソッドヘッダー(カスタムメンバーメソッド、オーバーライドメソッド、および属性メソッドを含む)は、メソッドヘッダーでコメント化する必要があります。Enter/ ** + Enter docコメントを入力または設定(設定-> Keymap-> Fix doc comment)ショートカットキー、ASはテンプレートを生成するのに役立ちます。パラメーターを完成させるだけです。

    • ブロックコメント:ブロックコメントは、それらを囲むコードと同じインデントレベルです。それらは/ * ... * /のスタイル、または// ...のスタイルにすることができます(//の後にスペースがあるのが望ましい)。複数行の/ * ... * /コメントの場合、後続の行は*で始まり、前の行の*に揃える必要があります。

    • その他のコメント:ASはいくつかのコメントテンプレートを統合しています。直接使用するだけで済みます。コードにtodoやfixmeなどのコメントテンプレートを入力すると、Enterキーを押すと表示されます。

  • インターフェース仕様
    •  データの全体的な統一:

      既存のデータ形式によると、返されるデータは次のように統合することをお勧めします:{"status":1、 "msg": "success"、 "data": "" ... "} dataは対応する返されるデータであり、JSONキー値にすることができますいずれかのタイプのデータが異常である場合、ステータスは0または他の定義された整数であり、msgはエラーメッセージであり、対応するデータの形式は次のとおりです。   

    • LiYingによって

 

おすすめ

転載: www.cnblogs.com/widgetbox/p/12753749.html