코딩 관례(convention)

Convention의 뜻은 관습, 관례이다. 코딩 컨벤션이란 프로그램의 소스 코드 작성 시 코딩 방식과 규칙을 정하고 그것을 따름을 의미한다.

무조건 따라야 할 절대적인 이유는 없지만, 몇 가지 장점이 있기에 대체로 프로젝트를 시작할 때 미리 규약을 정의하고 개발자들이 따르도록 하는 경우가 많다.

코딩 방식(style)

인간은 저마다 개성을 가진 고귀한 존재이므로, 소스 코드 작성 시에도 그 개성을 나타낸다. 같은 로직을 표현하는데도 다른 외관이 나타날 수 있는데, 사실 컴파일러가 코드를 해석하는데는 아무 문제가 없다.

프로그래밍 언어마다 전통적이고 유명한 코딩 방식이 존재하고, 개발자는 보통 그 중 하나를 택하여 그대로 사용하거나, 개인화(customizing)하여 사용하기도 한다.

가끔 코딩 방식 없이 일관되지 못하게 짜놓은 코드를 보는 경우가 있는데, 아무리 좋은 로직이라 하더라도 소스 코드의 질이 굉장히 떨어져 보인다.

관례를 따랐을 때의 장점

소스 코드의 가독성 향상

소스 코드를 최초에 작성하는 사람이 존재한다면, 추후에 그 소스 코드를 수정해야 하는 사람 또한 존재할 것이고 그 둘이 같은 사람이라고 보장할 수 없다. 그렇기 때문에 최초 작성자는 본인이 아닌 다른 사람이 자신의 소스 코드를 볼 수 있다는 점과 이해하기 쉽도록 만들어야 한다는 점을 간과해서는 안 된다.

그리고 프로그램은 여러 사람이 함께 만드는 일이 많기 때문에, 각자의 방식으로 소스 코드를 작성하면 전체적인 소스 코드가 일관되지 못하게 된다.

결국 유지보수에 있어서 관례를 따르는 것은 충분한 장점이 있다.

소스 코드의 품질 향상

소스 코드를 깔끔하게 작성하게 되면 그 소스 코드를 잘 이해할 수 있게 되고 구조를 파악하기 용이해진다. 흐름을 잘 이해하게 되면 코딩 실수를 방지할 수 있고 잠재적인 버그 발생을 억제할 수 있다.

소스 코드의 품질 향상은 프로그램의 품질 향상으로 이어진다.

이클립스로 소스 코드 작성시 코딩 관례 적용

자바 소스 코드 편집기로는 이클립스 IDE가 독보적으로 사용되고 있다. 따라서 이클립스 상에서 소스 코딩 시 코딩 관례를 적용하는 방법을 살펴보겠다.

Preferences - Java - Code Style

 추후 작성

Clean Up

 추후 작성

Code Template

  추후 작성

Formatter

 일요일에 작성

Organize Imports

 추후 작성

코딩 방식을 구분 짓는 요소

코딩 방식은 다음과 같은 요소의 조합으로 결정된다.

들여 쓰기(indent)

블록 지정

(가독성을 위해) 빈줄을 넣는 시기

띄어 쓰기

주석

배열 초기화

식별자 명명 규칙

잘 알려진 코딩 방식 종류

K&R 방식

자바 코딩 규약에서 사용하는 방식으로 한국에서 가장 많이 쓰이고 있다.

예시

public static void main(String[] args) {

}

장점

단점

Allman 방식

Whitesmith 방식

GNU 방식

이클립스에 코딩 컨벤션 적용하기

Allman 방식으로...

프로파일 배포

http://gyumee.egloos.com/1306012