Android 플랫폼 팀 인코딩 사양

개술

코드를 더욱 잘 읽고 코드의 가독성을 높이며 코드를 심사하고 수정하는 과정에서 낭비하는 시간을 단축시키기 위해 패키지 이름, 클래스 이름, 인터페이스, 방법, 변수, 상수, 자원 이미지, 레이아웃 파일, 애니메이션 파일, 컨트롤러 ID, 색값, 사용자 정의View 등 성명 규범을 제정한다.기본 원칙: 명사 명명 대상, 동사 명명 함수.명사 해석:
4

작은 낙타봉 명명법: 첫 번째 단어를 제외한 나머지 모든 단어의 첫 번째 자모는 대문자로 쓴다

4

낙타봉 명명법: 모든 단어의 첫 번째 자모의 대문자

4

밑줄 명명법: 단어와 단어 사이에 밑줄로 간격을 두다

본문

가방

기본 규칙: 모두 소문자를 사용합니다.
app 메인 패키지 이름 참조: 예:com.hengda.smart.shanghaighg.m
이번 주요 정의 모듈 이름 또는 등급 이름(실제 개발에서 상응하는 구조에 따라 적절하게 수정할 수 있음)
가방
설명
com.hengda.xx.xx.xx.base
기본 공유 클래스, 예를 들어 BaseActivity, BaseFragment 등
com.hengda.xx.xx.xx.tools
공공 도구 방법류, 예를 들어 네트워크 상태 판단, 파일 경로 판단 등
com.hengda.xx.xx.xx.bean
각종javabean, 예를 들어 네트워크 요청 실체, 데이터베이스 실체 등
com.hengda.xx.xx.xx.db
데이터베이스 운영 클래스
com.hengda.xx.xx.xx.adapter
모듈 또는 공용 어댑터 클래스
com.hengda.xx.xx.xx.view
사용자 정의view
com.hengda.xx.xx.xx.service
서비스
com.hengda.xx.xx.xx.broadcast
방송류
com.hengda.xx.xx.xx.listener
사용자 정의 감청기

2종류명

기본 규칙: 낙타봉 명명.
클래스
규칙.
예를 들다.
Activity 클래스
Activity를 접미사로 표시
메인 인터페이스:MainActivity, 로그인 인터페이스 Loginactivity
Fragment 클래스
Fragment 접미사로 식별
맵:MapFragment, 사용자:UserFragment
어댑터 클래스
어댑터를 접미사로 표시
사용자 어댑터:UserAdapter
공통 방법류
Utils 또는 Manager 는 접미사로 식별됨
스레드 풀:ThreadPoolManager, 로그 도구:LogUtils
데이터베이스 클래스
DBHelper를 접미사로 표시
전시품 데이터베이스: ExhibitDBHelper
서비스 클래스
서비스 접미사로 식별
수신 서비스:BeaconService
방송류
receiver를 접미사로 표시하기
알림 브로드캐스트: NotifyReceiver
adapter의 ViewHolder
Holder를 접미사로 표시
동반자 목록의 PartnerHolder
실체 빈
bean을 접미사로 표시하기
사용자 개체 UserBean
클래스 주석
모든 종류, 인터페이스에 주석을 추가해야 합니다. 형식은 다음과 같습니다.

    /**
     * author:  
     * time:  
     * desc:  
     */

3 커넥터

기본 규칙: 낙타봉 명명.
감청 클래스 인터페이스는 대문자 I로 시작합니다. 예를 들어: INotify Listener, INotify Call Back 등 터치 클래스는 On으로 시작합니다. 예를 들어: Onclick Listener.

4 방법

기본 규칙: 작은 낙타봉의 명칭, 병음 금지;
주의 사항
4

함수 이름에 매개 변수를 설명하지 마세요. 전혀 의미가 없습니다.예를 들어findExhibitByAutonumAndType(int autoNum, int type)은findExhibit(int autoNum, int type)로 간소화할 수 있다

4

상하문이 주어를 암시했는지 주의한다. 예를 들어 정보를 저장하는 방법은saveMessage()라고 할 수 있고 이것이Message류의 한 방법이라면save()로 간소화할 수 있다

4

일반적인 상황에서 표현이 명확하지 않은 단어를 사용하지 마라. 예를 들어do,handle,perform,return 등이다

4

방법 매개 변수는 의미를 정확하게 표현해야 한다. 예를 들어doSomething(String s1, String s2, String s3)은doSomething(String userName, String userEmail, String userId)이라고 써야 한다

또한 Activity, Fragment, 각종 View, 인터페이스 등에서 아래 규칙에 따라 상응하는 방법을 명명하십시오
메서드
설명
initXX()
레이아웃 initView 초기화 () 와 같이 init를 접두사로 표시하는 방법을 초기화합니다.
getXX()
데이터에 직접 접근할 때, 예를 들어javabean의 데이터 획득 등 다른 경우 더 정확한 동사를 선택한다
isXX()
방법 반환값은boolean형,is,are,was,were로 시작하거나 정태동사,can,could,may,might,must,shall,should,will,would를 조합한다. 이 단어들은 현재 조건을 진짜로 가정한 반문 정보를 담고 있다.예를 들면 Button.isEnabled(),User.canAccess()
showXX()
힌트 상자와 힌트 정보를 팝업합니다. 예를 들어 showErrorToast ().예를 들어 showSucceesDialog()
saveXX()
데이터 저장
clearXX () 또는 removeXX ()
데이터 지우기
drawXX()
도형을 그리다
resetXX()
데이터 재설정
setXX()
데이터 또는 객체 직접 할당
메소드 주석
중요한 방법은 다음과 같은 형식으로 메소드 주석을 추가해야 합니다.

     /**
      * desc:  
      * @param         
      * @param    2     
      * @return        (   void    )
      * @throws Exception     (  )
      */

메서드 내부 논리 주석은 모두 "//"형식으로 표시되며 주석은 주석이 필요한 문장 위에 있습니다. 예를 들어

      //    
      if (response.succeed() == 0) {
      }

5 변수

기본 규칙: 작은 낙타 봉명
1 퍼블릭이 아닌 비static의 필드 이름은 m로 시작합니다. 예를 들어 mXButton, mXXListener 등입니다.2 다른 필드는 소문자로 시작합니다. 예를 들어 userName,passWord.3 static 필드 이름은 s로 시작합니다. 예를 들어 sSingleton,

6 상수

기본 규칙: 모든 대문자, 단어는 줄임말로 읽지 않고 뜻을 아는 원칙, 밑줄 명명법.예: MAXSCREEN_WIDTH.

7 리소스 이미지

기본 규칙: 모든 소문자, 밑줄 명명법으로 단어에 병음이 나타나는 것을 금지한다.
시작 아이콘:iclauncher.png
그림이 각 모듈을 공용할 수 있다면 모듈 이름을 추가하지 않아도 됩니다. 그렇지 않으면 모듈 이름을 추가해야 합니다.
타입
규칙.
예를 들다.
누름단추
btn_모듈기능상태 또는 btn기능컨디션
btn_login_back_normal.png 또는 btnback_normal.png
아이콘 클래스
ic_모듈설명 또는 ic설명
ic_usercenter_userheader.png 또는 icuserheader.png
배경.
bg_모듈 또는 bg설명
bg_login.png 또는 bgwhite.png
그림
img_모듈설명 또는 img설명
img_login_header.png 또는 imgheader.png
클릭 효과 컨트롤 포함
btn_모듈기능selector 또는 btn기능selector
btn_login_back_selector.xml 또는 btnback_selector.xml
기본 그림
def_모듈설명 또는 def설명
def_usercenter_header.png 또는 defheader.png
분할선
div_설명
div_top.png
이름:
컨디션
_normal
묵인
_pressed
누르다
_focused
포커스 가져오기
_disabled
클릭 불가
_checked _selected
선택됨
_hovered
커서 가져오기
_checkable
선택 가능
_activated
활성화
_windowfocused
창 초점
클릭 효과 상태 명명 규칙 (android-selector-chapek 참조 본 규칙은android-selector-chapek 플러그인으로 selecter 파일을 신속하게 생성할 수 있음)

8 레이아웃 파일

기본 규칙: 모든 소문자, 밑줄 명명법, 단어는 병음이 나타나지 않도록 한다.
이름:
규칙.
예를 들다.
Activity
activity_모듈 이름.xml
activity_register.xml
Fragment
fragment_모듈 이름.xml
fragment_map.xml
Dialog
dialog_설명xml
dialog_editname.xml
List 목록
item_설명xml
item_partners.xml
PopupWindow
ppw_설명xml
ppw_floorlist.xml
기타 하위 레이아웃
모듈설명item.xml
main_menu_item.xml
포함 항목
layout_설명xml
layout_header.xml

9 애니메이션 파일

기본 규칙;모든 소문자, 밑줄 명명법;

10 컨트롤 Id

기본 규칙: 모든 소문자, 밑줄 명명법, 단어는 병음이 나타나지 않도록 한다.
형식:컨트롤 약어기능
컨트롤
약어
Button
btn
TextView
tv
ImageButton
ib
ImageView
iv
Linearlayout
ll
Relativelayout
rl
Framelayout
fl
EditText
et
SeekBar
skbar
ScollView
scv
ListView
lv
ProgressBar
psbar
WebView
wv
CheckBox
cb
RadioButton
rb

10 colors.xml

기본 규칙: 모든 소문자, 밑줄 명명법;
분류하다
규칙.
예를 들다.
단색
직접 색상 값 이름 지정
black
비단색
모듈 설명 주제 색상
login_username_light
APP에 단일 테마만 있으면 테마 색상을 설정하지 않아도 됩니다

11 사용자 정의 View

기본 규칙: 낙타봉 명명법, View로 끝
형식: 기능+View 예: TipsView,

12 Menu 메뉴

기본 규칙: 모든 소문자, 밑줄 명명법;
형식: 모듈 기능.xml 예: 검색add.xml은menu 파일을 menu 폴더에 통일적으로 두기 때문에menu 접두사를 추가할 필요가 없습니다.

13 strings.xml

//아직 생각 안 했어
Google Java Style 중국어 버전 안드로이드 코드 안드로이드 개발 모범 사례 참조