素人プログラマ奮闘記

javaの初心者がAndroidのことを独学で勉強しつつ、メモを残していきます。

コーディング規約メモ

今まで結構な数のアプリを作成しましたが、クラス名、変数名、コントロール名など
名前を付けるときに結構悩んでしまいがちなので
ある程度自分流規約をメモしていこうとおもいます。
基本はjavaの規約を参考にしています。
定期的にみなおして、項目をふやしていくつもりです。
なるべく標準に近い規約にしてますが、あくまで自分ルールのため、公式とは違う箇所も多々ありますが、あしからず。

命名規則

パッケージ名

"."で区切られた文字を使用する
例:jp.co.domain.projectname;

ファイル名

ファイル名はクラス名と同じにする
基本1ファイル1クラス構成にする
例:TestPoint.java

クラス名

先頭大文字、単語の区切りは大文字ではじめること
例:TestPoint

例外クラス名

先頭大文字、単語の区切りは大文字ではじめること
クラス名の末尾にExceptionとつける。 例:TestErrorException

インターフェイス名

先頭大文字、単語の区切りは大文字ではじめること
一番最初にIを付ける
例:INameOfInterface

抽象クラス名

先頭大文字、単語の区切りは大文字ではじめること
一番最初にAbstractを付ける
例:AbstractTestPoint

定数

大文字を"_"でつないだもの
例:TEST_`POINT_WORD

メソッド名

最初小文字で、区切りは大文字ではじめること
例:createTestPoint()
●ファクトリ(Newする)メソッド
例:newTest,createTest()
●変換(コンバート)メソッド
例:toTest()
●属性取得(プロパティ)メソッド
例:getTest()
型がboolの場合の例:isTest()

プロパティ名

先頭にgetter/setterを付ける
ただし型がbooleanであるプロパティについてはGetterとして"isPropertyName()"にする
例:getterDate()
  setterDate(int date)
例;isFlg()
setterFlg(boolean flg);

名前の対象性

クラス名、メソッド名を付ける際は、英語の対象性に気を付ける
add / remove
insert / delete
get / set
start /stop
begin / end
send / receive
first / last
get / release
put / get
up / down
show / hide
source / target
open / close
source / destination
increment / decrement
lock / unlock
old / new
next / previous

(xml)に関する命名規約

layout(xml)で各コントロールのandroid:idのつけ方

全て小文字で区切りはアンダースコアを使う 例:TextViewコントロール : test_text
例:EditTextコントロール : test_edit
例:Buttonコントロール : test_button
例:ImageViewコントロール : test_image
例:Viewコントロール : test_view
例:ViewFlipperコントロール : test_flipper

strings(xml)での命名について

全て小文字で区切りはピリオドを使う 例:Textで使用する場合 : text.aaaaa
例:buttonで使用する場合 : button.aaaaa
例:ダイアログで使用する場合 : dialog.aaaaa
例:メッセージで使用する場合 : message.aaaaa
例:エラーメッセージで使用する場合 : errormessage.aaaaa

カテゴリーへ

inserted by FC2 system