코딩규약

C# 코딩 규약에 대해 읽어보다가 정말 중요한 것 몇가지를 포스팅 해보려 한다.

C#에 국한된 것은 아니고, 모든 언어가 이런식으로 코딩하면 좀더 좋은코드, 읽기 좋은 코드가 될 것 같다. ^_^

좋은코드의 특징

-신뢰성

-관리성

-효율성

1) 클래스와 메소드 명은 파스칼 케이싱을 사용한다.

public class HelloWorld {

void GetStatus() {

}

}

2) 변수명은 캐멀 케이싱을 사용한다.

int totalCount;

string bookName;

3) 인터페이스는 앞에 I 를 붙힌다.

interface IEntity {

}

4) 변수명에는 의미를 부여하자. 예를 들면 함축적인 형태로 사용하지 말자는 것이다. 이는 나중에 알아보기도 힘들고, 다른 사람은 더더욱 알아볼 수가 없다.

string addr;

위 대신

string address;

위와 같이 선언하는 것이 의미가 분명하다.

5) 멤버변수(전역변수)에는 _(언더바)를 적극 활용하자. 멤버변수인지 알아보는 표기로 적당하다.

6) if 문, for문 등에 괄호에는 공백을 두자.

if( isShow() )

{

//code

}

for( int i=0; i<5; i++ )

{

i++;

}

7) Enum 을 적극활용하자.

  하드코딩된 int 나 string 값을 사용하지 말자.

-함수작성규칙-

1) 함수는 1~25 줄로 짧게 작성한다.

2) 함수명은 명확히 작성하자. (의미가 분명하게)

void SavePhoneNumber( string phoneNumber )

{

}

옳지 못한 사례

void ShowDetails( string phoneNumber )

{

//무엇을 보여주려는지 의미가 불분명하다.

}

3) 함수에는 하나에 한가지 작업만 하자.