Java Code Convention

출처 : http://greencode.tistory.com/14

 

 

저도 c, c++은 약 8~9년 가량 해왔고 java는 그에 비하면 3~4년이라는 비교적 짧은 시간동안 접한 언어입니다. 한때 몸에 배어 있는 Coding Practice 라는게 참 무섭다고 느껴진게 c/c++ style로 모든 언어를 해석하려 들고 또한 모든 언어에 대해 이런 스타일로 코딩하려고만 합니다. Media cluster encoding 관련 open source project에 첫 commitor로 활동할때 함께 code로 생각을 공유하는 공간에서 나만의 갇힌 언어로 내가 구현 한 부분은 나만이 알아보고 나만이 수정 가능한 형태가 되어 그들을 혼란시켜서 혼줄이 났던 기억이 있습니다.

처음에는 편해 보일지언정 각 언어에 대한 특성이 있고 그 언어만의 매력이 존재 하는 것을 모르고 덤벼들었으니 당연히 coding communication이 될리가 만무합니다. 아래 글에서도 언급하겠지만 본인이 개발한 소스에 대한 유지보수를 본인이 할 가능성은 보기 힘들다고 합니다. 혼자개발하고 혼자 유지보수하고 혼자만의 공간에서 작업한다면 앞으로 할 이야기들은 다 관련 없는 이야기 입니다. 하지만 당신이 많은 사람들과 함께 하게 될 developer라면, 그리고 java를 다루고 있다면 아래의 짧은 내용을 읽어보고 한번쯤은 되새겨 봤으면 하는 바람입니다.

 

[Sun에서 제시한 Coding convention의 필요성]

- http://www.oracle.com/technetwork/java/codeconv-138413.html

Code Conventions for the Java Programming Language This Code Conventions for the Java Programming Language document contains the standard conventions that we at Sun follow and recommend that others follow. It covers filenames, file organization, indentation, comments, declarations, statements, white space, naming conventions, programming practices and includes a code example. 80% of the lifetime cost of a piece of software goes to maintenance. Hardly any software is maintained for its whole life by the original author. Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly. The Code Conventions for the Java Programming Language document was revised and updated on April 20, 1999.

 

위의 중요 내용은

1. 소프트웨어를 개발하는 일련의 모든 과정에 들어가는 비용 중 80%가 유지보수에 쓰여진다.

2. 소프트웨어의 유지보수를 그 소프트웨어를 직접 개발한 개발자가 담당하는 경우는 거의 보기 힘들다.

3. 코드 규칙을 지키면 다른 개발자가 그 소스코드를 처음 보았을 때, 더 빠른 시간안에 완벽하게 이해할 수 있도록 도와주기 때문에, 소프트웨어의 가독성이 높아진다.

 

---

Sun에서 제시하는 Coding convention의 주요 내용은 아래의 링크를 참조한다.

http://www.oracle.com/technetwork/java/codeconvtoc-136057.html

(PS. 영어가 보기 힘들다면 간단히 번역 해놓은 버전도 첨부함)

 

 

 

Java_Code_Conventions(한글).pdf

 

 

아직도 많은 사람들이 C style로 또는 자기 혼자만의 세계에 갇혀서 작업하고 있다.

모두가 함께 하는 pair programming에서 독자적인 coding은 자제하고 sun에서 제시한 conding convention을 꼭 읽어보길 바란다.

---

아래는 한눈에 conding convention에 대해 이해가 갈 수 있도록 만들어 놓은 이미지.

 

 

 

 

 

 

 

 

[Official site]
- http://www.oracle.com/technetwork/java/codeconv-138413.html

[User site]
- programming convention(번역) : http://blog.naver.com/hyowong/80000631451
- java 코딩 지침(여러가지 coding Guide line을 제시) : http://blog.naver.com/jeany4u/20003876157
- 자바 코딩 규칙 / Java Code Convention : http://goo.gl/lDK4q