안드로이드 자바 코틀린 기초 지식/안드로이드 기초 지식

안드로이드 style guide 2 (coding convention)

Everyday Growing Engineer 2022. 8. 30. 10:10

프로젝트를 하면서 변수명을 너무 멋대로 지어서 안드로이드 코딩할때의 기준을 잡고 해야할 필요성을 느꼈습니다.

습관이 되기 전까지는 계속 보면서 따라해야할듯 싶습니다.

A. Follow Field Naming Conventions

  • 1. Non-public, non-static field 는 m으로 시작
private int mPrivate;
protected int mProtected;
int mPackagePrivate;

 

  • 2. Static field 는 s로 시작
private static MyClass sSingleton;

 

  • 3. 나머지는 소문자로 시작 (public)
public int publicField;

 

  • 4. Public static final fields (상수) 는 모두 대문자로 ALL_CAPS_WITH_UNDERSCORES
public static final int I_AM_CONSTANT = 33;

 

  • 1~4 모음 예제
public class MyClass {

	public static final int MY_CONSTANT = 33;
	public int myPublicVariable;
	private static MyClass sSingleton;
    private static int sStaticVariable;
	int mVaraible;
	private int mPrivate;
	protected int mProtected;
}

 

B. Activity 개발 시 주의 사항

context를 별도 멤버로 선언하고 관리하지 않도록 하자.

context가 필요하면 getContext() 를 사용하자.

 

C. TODO 주석문 또는 FIXME 주석문을 사용 방법.

단기처방이나, 완벽하지 않은 해결책인 경우에는 반드시 TODO or FIXME주석문을 기입할 것.

// TODO: Something~~
또는
// FIXME: Something~~

 

D.  Don't Ignore Exceptions (예외를 무시하지 말것)

void setServerPort(String value) {
    try {
    	serverPort = Integer.parseInt(value);
    } catch (NumberFormatException e) {
		// 여기를 비워놓지 말고 예외 케이스를 설정!!!   
    }
}