[코드규칙] 변수 네이밍 규칙

변수명을 작성할 때에는 아래의 규칙을 반드시 적용한다

---

본 포스팅의 변수 네이밍 규칙은 필자의 규칙이므로 옳고 틀림의 문제가 아님을 알려드립니다.

특징

• 가독성을 확보할 수 있다.
• 변수명만으로 의미를 설명할 수 있다.
• 협업시 코드에 대한 이해도를 높힐 수 있다.

규칙

• const 변수는 모두 대문자로 표기하고 띄어쓰기를 '_'로 구분한다.

// 비권장
public const double MaxHeight = 10;

// 권장
public const double MAX_HEIGHT = 10;

• var을 사용하고 변수명을 통해 변수의 데이터 타입을 유추할 수 있도록 한다.

// 비권장
string str = "";

// 권장
var str = "";

• 복수형의 데이터는 -s를 붙혀 복수의 의미를 부여한다.

// 비권장
var element = new List<XElement>();
var elememtList = new List<XElement>();
// 권장
var elements = new List<XElement>();

• 가급적 'i', 'j', 'k'등의 알파벳 단위의 변수는 사용하지 않는다. (for문에서는 예외)

// 비권장
var n = 0;
// 권장
var number = 0;

• '_'를 사용해 전역 변수와 지역 변수에 따라 다르게 표기한다.

// 비권장
private string text;
// 권장
private string _text;

• 함수로 구분지어 변수명을 단순하게 작성할 수 있도록 한다.

// 비권장
public void Test(XElement element)
{
    var children = element.Elements();
    
    foreach(var child in children)
    {
        var childrenOfChild = child.Elements();
        
        foreach(var childOfChild in childrenOfChild)
        {
        	// ...
        }
    }
}

// 권장
public void Test(XElement element)
{
    var children = element.Elements();
    foreach(var child in children)
    {
    	TestChild(child);
    }
}

public void TestChild(XElement element)
{
    var children = element.Elements();
    foreach(var child in children)
    {
    	// ..
    }
}

• boolean 유형의 변수의 경우는 "예", "아니오"로 답할 수 있는 동사를 접두어로 사용한다.
  (can을 사용할 경우에는 is + 동사 + able 꼴을 사용한다.)

// 비권장
var error = false;
var canMove = false;

// 권장
var isError = false;
var isMovable = false;