読者です 読者をやめる 読者になる 読者になる

A Day In The Life

とあるプログラマの備忘録

Androidアプリ開発標準を作成してみました。

本格的にAndroidアプリの開発をするとなるとやはり開発標準が必要になると思います。

ガチガチに決める必要はありませんが、開発標準があれば複数人開発にも一定の秩序ができてやりやすくなるかと思います。

UI標準

  • D_PAD_CENTERまたはバックボタンで代用できる場合は極力ボタンを使用しないこと
  • Closeボタン、Cancelボタンは使用しないこと
  • DialogからActivityを起動したり別のDialogを起動しないこと
  • Activityを使うかDialogを使うかの指針は以下を参考にすること
    • Activityにする場合(ひとつでも当てはまればよい)
      • アプリケーションの起点(HOMEから呼ばれる)となる画面
      • 画面いっぱいに表示する必要がある
      • 処理した結果を呼び出し元に渡したい
      • 呼び出後に後続処理が必要
      • 画面遷移が必要な場合
      • オブジェクトが状態を保持する必要がある場合
    • Dialogにする場合
      • 上記以外

クラス名の命名規約

  • クラス名は大文字ではじめ単語の区切りは大文字ではじめること
  • クラス名は名詞または名詞+動詞にすること
  • ユーティリティクラス:末尾にUtilsをつける
  • ダイアログクラス:末尾にDialogをつける
  • Content Providerクラス:末尾にProviderをつける
  • Intent Receiverクラス:末尾にReceiverをつける

レイアウトファイルの命名規則

  • すべて小文字を使い単語の区切りはアンダースコアを使うこと
  • ダイアログボックス:末尾に_dialogをつける
  • List,Grid,Spinner等のリスト要素:末尾に_list_itemをつける

レイアウトXMLで使用するandroid:idの命名規則

  • すべて小文字を使い単語の区切りはアンダースコアを使うこと
  • TextView:末尾に_textをつける
  • EditText:末尾に_editをつける
  • Button:末尾に_buttonをつける
  • ImageView:末尾に_imageをつける
  • GridView:末尾に_gridをつける
  • MapView:末尾に_mapをつける

strings.xmlのname属性の命名規則

  • アプリケーション名はapp_nameにすること
  • メニューで使用する文字列はmenu_ではじめること
  • ボタン名に使用する文字列はbutton_ではじめること
  • アクティビティのタイトルはactivity_title_ではじめること
  • ダイアログのタイトルに使用する文字列はdialog_title_ではじめること
  • エラーメッセージで使用する文字列はerror_ではじめること
  • インフォメーションメッセージで使用する文字列はinfo_ではじめること
ツッコミ大歓迎です。

ちなみにJavaのコード規約は巷にあふれているので今回は作成しませんでした。