04. Naming :: 2021/11/17 17:48

개발자를 위한

Java Programming Style Guide (ref. Google style guide)

5. 네이밍(naming)


5.1 모든 식별자에 적용되는 공통 규칙(rules common to all identifiers)

식별자(identifier) ASCII 문자와 숫자만 사용하며, 아래에 언급된 소수의 경우에만 밑줄(underscore) 사용합니다. 따라서, 유효한 식별자 이름은 정규식(regular expression) \w+ 일치합니다.

(구글 스타일에서는) 특수한 접두사나 접미사를 사용하지 않습니다. 예를 들어, name_, mName, s_name, kName 같은 이름은 (구글) 스타일이 아닙니다.

5.2 식별자 유형별 규칙(rules by identifier type)

1. 패키지 (Package names)

패키지 명은 모두 소문자이며, 연속된 단어는 간단하게 서로 연결됩니다. (밑줄 없음) 예를 들어, com.example.deepSpace com.example.deep_space 아니라 com.example.deepspace 패키지명을 작성합니다.

2. 클래스 (Class names)

클래스 이름은 UpperCamelCase(단어가 시작되는 한글자를 대문자로 작성하는 유형) 작성합니다. 클래스 이름은 일반적으로 명사나 명사구입니다. 예를 들어, Character ImmutableList 같습니다. 인터페이스(Interface) 이름은 명사나 명사구(예를 들면, List) 수도 있지만, 때로 형용사나 형용사구가 수도 있습니다. ( : Readable)

어노테이션 유형의 명명(naming annotation type) 대해서는 특정 규칙이나 정립된(well-established) 규정(convention) 없습니다.

테스트 클래스(Test class) 테스트 중인 클래스 이름으로 시작하여 Test 끝나는 이름으로 명명합니다. : HashTest 또는 HashIntegrationTest

3. 메서드 (Method names)

메서드 이름은 lowerCamelCase( 한글자는 소문자로, 다음 단어의 한글자는 대문자로 작성하는 유형) 작성합니다. 메서드 이름은 일반적으로 동시 또는 동사구로 작성합니다. 예를 들면 다음과 같습니다. 

Ex) sendMessage 또는 stop

밑줄은 lowerCamelCase 작성된 컴포넌트와 이름을 논리적으로 구분하기 위해 JUnit 테스트 메서드에 나타날 있습니다. 한가지 일반적인 패턴은 <methodUnderTest>_<state> 형태입니다. (: pop_emptyStack). 테스트 메서드의 이름을 지정하는 한가지의 완벽한 방법은 없습니다.

4. 상수 (Constant names)

상수 명은 CONSTANT_CASE 같은 유형을 사용합니다. 상수 명은 모두 대문자이며, 단어는 하나의 밑줄로 다음 단어와 구분됩니다. 하지만, 정확하게 상수가 무엇일까요?

상수는 내용이 변경되지 않고(immutable), 메서드에 부작용(side effect) 전혀 없는 static final field 입니다. 여기에는 기본형(primitives), 스트링형(Strings), 불변 유형(immutable type), 불변 유형의 불변 컬렉션(immutable collection) 포함됩니다. 만약 인스턴스의 관찰 가능한 상태가 변경될 있다면, 그것은 상수가 아닙니다. 객체를 변경하지 않으려는 의도만으로는 충분하지 않습니다.

예를 들면 다음과 같습니다.

// Constants

static final int NUMBER = 5;

static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");

static final ImmutableMap<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32);

static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable

static final SomeMutableType[] EMPTY_ARRAY = {};

enum SomeEnum { ENUM_CONSTANT }


// Not constants

static String nonFinal = "non-final";

final String nonStatic = "non-static";

static final Set<String> mutableCollection = new HashSet<String>();

static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);

static final ImmutableMap<String, SomeMutableType> mutableValues =

    ImmutableMap.of("Ed", mutableInstance, "Ann", mutableInstance2);

static final Logger logger = Logger.getLogger(MyClass.getName());

static final String[] nonEmptyArray = {"these", "can", "change"};


이러한 이름은 일반적으로 명사나 명사구입니다.

5. 비상수 필드 (Non-constant field names)

상수가 아닌 필드 (non-constant field name) (static이든 아니든) lowerCamelCase 작성됩니다.

이러한 이름은 일반적으로 명사 또는 명사구로 작성됩니다.

예를 들면 다음과 같습니다.

Ex) computedValues 또는 index

6. 파라미터 (Parameter names)

파라미터(매개변수 : parameter) 명은 lowerCamelCase 작성됩니다.

Public 메서드에서 단일 문자 파라미터 이름은 피해야 합니다.

(다른 사람이 변수 명을 이해할 없습니다.)

7. 지역 변수 (Local variable names)

지역 변수 명은 lowerCamelCase 작성합니다. final이나 immutable 경우에도, 지역 변수는 상수로 간주하지 않으며 상수 스타일로 코드를 작성하면 됩니다.

8. 유형 변수 (Type variable names)

유형 변수 명은 다음 2가지 스타일 하나로 작성합니다.

 - 단일 대문자, 선택적으로 뒤에 단일 숫자 추가 (ex. E, T, X, T2)

 - 클래스에 사용되는 형태의 이름 뒤에 대문자 T (ex. RequestT, FooBarT)

5.3 카멜 케이스(camel case : defined)

“IPv6”이나 “iOS” 같이 두문자어나 특이한 구조가 있는 경우처럼 영어 구문을 Camel Case(영어 대소문자로 변환) 변환하는 합리적인 방법이 한가지 이상 있습니다. 예측 가능성을 개선하기 위해서 Google Style 표준에서는 다음과 같은 (거의) 결정적인 스키마를 지정합니다.


산문형 이름으로 시작 : 

1. 어구를 ASCII 변환하고 Apostrophe(‘) 제거하세요. 예를 들어, “Müller's algorithm” “Muellers algorithm”으로 변환됩니다.

2. 결과를 공백과 나머지 구두점(punctuation)으로 (일반적으로 hypen: ‘-‘)으로 분할하여 나눕니다.

    • 권장(Recommended) : 이미 전통적인 Camel Case 일반적으로 사용하고 있다면, 구성요소로 분할합니다. ( : AdWord ad word 분할됨) 하지만, “iOS” 같은 경우는 Camel Case 아니기 때문에 어떤 규칙에도 위배됩니다. 따라서 권장사항은 적용되지 않습니다.

3. 모든 항목(약어 포함) 소문자로 만든 다음, 첫번째 문자만 대문자로 합니다.

    • 단어를 Upper Camel Case 사용하거나, ( 단어의 첫글자를 대문자로)
    • 단어의 첫번째 글자를 제외하고,  Lower Camel Case 사용합니다. ( 단어의 첫글자 소문자, 다른 단어의 첫글자는 대문자로)

4. 끝으로, 모든 단어를 단일 식별자로 결합합니다.

원래 단어의 대소문자는 거의 대부분 무시되는 것에 유의하세요.

:

Prose form

Correct

Incorrect

"XML HTTP request"

XmlHttpRequest

XMLHTTPRequest

"new customer ID"

newCustomerId

newCustomerID

"inner stopwatch"

innerStopwatch

innerStopWatch

"supports IPv6 on iOS?"

supportsIpv6OnIos

supportsIPv6OnIOS

"YouTube importer"

YouTubeImporter

YoutubeImporter*


YoutubeImporter* : 수용 가능하지만, 권장하지 않습니다.


Note : 일부단어는 영어에서 모호하게 ‘-‘으로 연결됩니다. : 예를 들어, “nonempty” “non-empty” 모두 정확하기 때문에 checkNonempty, checkNonEmpty 모두 정확한 표현입니다.

Trackback Address :: http://www.yongbi.net/trackback/889
  • goto88

    Tracked from goto88 | 2022/01/21 15:26 | DEL

    Great Architect &amp; Artist -

[로그인][오픈아이디란?]
오픈아이디로만 댓글을 남길 수 있습니다
Name
Password
Homepage

Secret
< PREV |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  ...  646  |  NEXT >