Coding Convention

* Coding Convention

https://kanetu.github.io/coding/2019/10/15/coding-convention.html

코드 개발의 품질에는 코드를 작성할 떄 규칙을 준수하는 것이 중요하다. 코딩 컨벤션은 형식 지정 뿐만 아니라 선택한 프로그래밍 언어 및 선택한 개발 프레임워크에 대한 코딩 규칙에 따라 결정되는 많은 요소에도 적용된다.

Coding Convention은 다음과 같은 항목에 적용된다. 

•  이름 짓는 방식과 변수 이름 등 식별자에 사용되는 대소문자
• Camel 표기법으로 할것인지, Pascal 표기법, snake 표기법 등의 표기법
• 블록의 들여쓰기 스타일 - 탭을 쓸 것인지, 너비는 어떻게 할 것인지 등
• 대괄호 배치 방법 - 메소드 바로 옆에 붙일 것인지 한 줄 띄고 붙일 것인지
• 클래스 및 인터페이스 선언 등....

 

그렇다면 coding convention은 왜 사용하여야 할까??

소프트웨어는 40%-80%가 유지 관리에 사용되며 기존 작성자가 다시 작성하는 경우는 거의 없다. 따라서 모두가 정해진 규칙에 따라 코드를 작성하면 가독성이 향상될 수 있다. 가독성이 향상되면 개발의 속도에서 유리함을 추구할 수 있다.  Coding convention은 개발자가 새로운 코드를 더 빠르고 더 잘 이해할 수 있도록 해준다.  또한 git conflict를 예방하는 하나의 기본적인 방법? 이 될 수도 있다. 

 

* JAVA의 Coding Convention

Oracle에서 1997년 지정한 Java의 코딩 컨벤션은 다음과 같다. 

https://www.oracle.com/technetwork/java/codeconventions-150003.pdf

읽어보면 나름 재밌다. 한 줄 주석을 달 때 // 이것보단 /* 이렇게 다는 것을 권장하는 듯 싶다.*/

그러나 Oracle에서도 어디까지나 이렇게 권장하는 것이지, 구글에서의 JAVA Coding Convention은 또 다르고 아무튼 만약 본인이 속해있는 회사, 팀, 프로젝트에서 정한 코딩 컨벤션이 있다면 해당 규칙을 따르면 된다.