[오픈소스소프트웨어] 불린 변수

전형적인 불린 변수명을 사용 - done,error,found,success,ok

참이나 거짓을 함축한 이름을 사용 - status -> error or statusOK

sourceFile -> sourceFileAvailable, sourceFileFound

긍정적인 이름을 사용 - notFound, notDone, notSuccessful 같은 경우 부정이 첨가된 경우 읽기 어려워짐

접두사를 사용하여 그룹의 의미 전달 

ex)Color_Red, Planet_Earth, Month_Jnnuary

 

클래스 내에 사용되는 경우에는 접두사를 생략할 수도 있다.

Color.Color_Red -> Color.Red

 

용도에 따른 명명 규칙들 - 상수

상수가 나타내는 숫자보다는 추상적 대상을 표현하도록 한다.

-final int FIVE = 5.0;

 

-final int CYCLE_NEEDED = 5.0;

다음과 같이 변경되어도 의미 전달

-final int CYCLES_NEEDED = 6.0;

 

일반적인 명명 규약 - 언어 독립적 (1)

변수의 이름과 루틴의 이름을 구별한다.

예)변수와 객체는 소문자로 시작, 루틴은 대문자로 시작

 

타입(클래스)와 객체를 구별한다

예1) 첫번째 문자를 대문자로 하여 타입과 변수를 구분 - LongerWidget longerWidget;

예2) 모든 문자를 대문자로 작성하여 타입과 변수를 구분 - LONGERWIDGET longetWidget;

예3) 타입에 "t_" 접두사를 사용 t_LongerWidget longerWidget;

예4) 변수에 "a"접두사를 사용 - LongerWidget aLongerWidget;

예5) 변수명에 구체적인 이름을 사용 LongerWidget fullEmployeeWidget;

 

전역 변수를 식별한다

예) g_RunningTotal

 

멤버 변수를 식별한다

예) m_runningTotal

 

형 선언을 식별한다

예) 클래스 이름을 모두 대문자 혹은 "t_" 접두사 사용 - COLOR, MENU 또는 t_Color, t_Menue

 

열거 형의 요소를 식별한다

예) "e_" 또는 "E_" 접두사와 "Color_", "Planet_"의 접두사를 혼합 사용

 

입력만 하는 매개변수를 지정할 수 없는 언어에서는 이를 식별한다

예) 참조 호출과 값호출을 구분하기 위해 ByRef, ByVal를 사용

예) 수정 불가능한 매개변수에 final 또는 const를 사용 -constMax

 

가독성을 강화하기 위해 이름을 형식화한다.

예) 대소문자를 섞어 쓰거나 '_'를 사용 - gymnasticsPointTotal, gymnastics_point_total

 

 

일반적인 명명 규약 C언어

- c, ch는 문자변수

- i, j 는정수

- n은 숫자를 의미

- p는 포인터

- s는 문자열

- 전처리기 매크로는 모두 대문자와 밑줄로 표시

- 변수와 루틴의 이름은 소문자와 밑줄을 사용

- 밑줄 문자는 구분자를 사용 예) letters_in_lowercase

 

 환경에 따라

-MS Windows에서는 hungarian 명명 규약을 사용, 변수명에 대소문자 혼용

-Macintosh에서는 루틴의 이름을 대소문자 혼용 (Pascal의 영향)

 

일반적인 명명 규약 C++

- i , j 는 정수

- p는 포인터

- 상수, typedef, 전처리기 매크로는 모두 대문자와 밑줄을 사용

- 타입명은 MixedUpperAndLowerCase 형식

-변수는 첫문자를 소문자로 시작하고 대소문자를 조합

-밑줄은 모두 대문자로 이루어진 이름 또는 특별한 접두사를 사용하는 경우 이외는 사용하지 않는다

 

일반적인 명명 규약 Java

- i , j 는 정수

- 상수는 밑줄로 구분되는 대문자로 표시

- 타입명은 MixedUpperAndLowerCase 형식

-변수는 첫문자를 소문자로 시작하고 대소문자를 조합

- 밑줄은 모두 대문자로 이루어진 이름을 제외하고는 사용하지 않는다

접두사 get/set은 접근자로 사용

 

표준화된 접두사들 - 의미적 접두사

c - 카운트

first - 현재 연산 범위에서 배열의 첫번째 요소

g - 전역변수

i - 배열 인덱스

lawst - 배열 마지막 요소

lim - 배열의 상한선

m - 인스턴스 수준의 변수

max - 리스트 마지막 요소

min - 리스트 첫번째 요소

 

변수명의 축약 - 일반적 지침

표준 축약어를 사용

 

불필요한 모음을 제거 computer->comptr, screen -> scrn

 

관사 및 접속사는 제거

 

각 단어의 첫 문자 또는 처음 몇 개의 문자를 사용

 

각 단어의 첫 번째와 두 번째, 세 번째 다음에 오는 것을 일관성 있게 자른다.

 

각 단어의 처음과 마지막 문자를 유지한다.