안드로이드 스튜디오 코드 포메터 (스타일/규약/convention)

목   차

1. 코딩 스타일이 왜 중요한가?

2. 구글의 코딩 스타일

A. 구글 Java 코딩 스타일

B. Android Code Style 가이드라인

3. Androud Studio에 포맷터 적용하기

A. 스타일 다운받기

B. codestyle에 복사하기

C. 스타일 적용하기

4. 참조

1. 코딩 스타일이 왜 중요한가?

코딩 스타일을 맞추는 이유는 여러 사람이 협업을 할 때 최소한의 가독성을 확보하기 위해서다. 안타깝게도 코딩 스타일을 100% 맞추더라도 다른 사람의 코드를 읽는 다는 것은 쉽지 않다. 모든 프로그래머는 각자의 생각, 구현 스타일을 가지기 때문이다.

코딩 스타일이 존재하지 않는 앱은 품질이 점차 나빠져서 결국에는 유지보수가 불가능해 질 수 있다.

개인적으로는 구현 능력보다는 코딩 스타일을 준수하는 프로그래머가 장기적으로는 더 훌륭하다고 생각한다. 구현 능력이 있으나 자신의 스타일로 구현해 놓은 코드는 그 사람이 퇴사하는 동시에 유지보수가 불가능해지기 마련이다. 평생 직장이란 용어가 어색해지고 있는 시점에서 누군가와 평생을 같이 일한다는 가정을 하는 것은 무리다.

2. 구글의 코딩 스타일

굉장히 의외였는데 코딩 스타일이 번역된 포스팅이 하나도 없다. 못 찾은 건가…

충분히 중요하다고 생각되는 내용인데 왜 없을까?

따라서 내일하고 모래에 두 문서를 요약해서 포스팅 할 예정이다.

A. 구글 Java 코딩 스타일

우선 원문은 아래에서 읽을 수 있다.

http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

(다음 포스팅을 참조하자)

B. Android Code Style 가이드라인

아래에서 원문을 읽어볼 수 있다.

http://source.android.com/source/code-style.html

(다다음 포스팅을 참조하자)

3. Androud Studio에 포맷터 적용하기

코딩 스타일을 모두 기억하고 구현하는 것이 좋지만 가끔씩 틀릴 때도 있을 테니 IDE의 도움을 받자.

A. 스타일 다운받기

다음 링크에 가보면 AndroidStyle.xml 파일을 다운 받을 수 있다. 안드로이드 코딩 스타일 룰을 안드로이드 스튜디오 설정 파일에 맞게 만들어 놓은 파일이다. 이미 2년 이상 변동이 없으므로 향후에도 변경 가능성은 낮아보인다.

편의를 위해 AndroidStyle.xml 파일은 첨부한다.

B. codestyle에 복사하기

다운 받은 AndroidStyle.xml 파일을 지정된 config 디렉토리에 복사해야 한다. 내가 사용 중인 Android Studio에서는 위치가 다음과 같았다. 참고해서 복사해 넣자.

• 윈도우 : C:\Users\XXX\.AndroidStudio1.2\config\codestyles\AndroidStyle.xml

• 리눅스 : ~/.AndroidStudioPreview/config/codestyles/AndroidStyle.xml

• 맥OS : ~/Library/Preferences/AndroidStudioPreview/codestyles/AndroidStyle.xml

C. 스타일 적용하기

안드로이드 스튜디오를 다시 시작을 시킨다. 그리고 [File → Settings] 를 클릭하면 다음과 같이 AndroidStyle이 새롭게 추가된 것을 볼 수 있다. 선택하자.

4. 참조

• http://anton46.com/importing-the-official-android-code-style-to-android-studiointellij/

• http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

• http://source.android.com/source/code-style.html

AndroidStyle.xml