우테코 7기/프리코스

[1주차] Coding Convention이란

Jackpod1001001 2024. 10. 16. 16:21

우아한 테크코스의 프리코스 1주차를 진행하며 "자바 코드 컨벤션을 지키면서 프로그래밍한다" 라는 부분을 보며, 코드 컨벤션이라는 개념을 처음 접하게되었다.

그동안은 혼자 코드를 작성하는 일이 대부분이었고, 간혹 팀 프로젝트를 하더라도 소규모 또 유지보수할 일도 없었기에 크게 신경 안쓰던 부분이었다.

그러나 현업에선 다수의 개발자가 같이 협업을 하고, 유지보수 또한 작성한 사람이 아닌 다른 사람이 하게되는 경우가 많기에 이런 코딩 컨벤션을 지키는것이 중요함을 알게되었다.

코딩 컨벤션이란?

코딩 컨벤션이란 코드를 어떻게 작성할지에 대한 룰을 말한다. 탭의 스페이스 개수, 줄바꿈 ,조건문,반복문에서 중괄호는 어떻게 할것인지, import시에 wildcard를 쓰지 않기 등등이다.

 

코딩 컨벤션이 필요한 이유

위에서도 말했듯, 내가 쓴 코드를 다른 사람들이 보게되는 일이 많기에 코드의 가독성을 위해서 쓰인다.

  • 코드의 가독성이 좋아짐
  • 유지보수에 용이함

 

코딩 컨벤션 적용하는 법

 

XML 포매터를 다운받아서 위와 같이 적용하면 된다.

프리코스에서 사용하는 코딩 컨벤션

프리코스에서 사용하는 코딩 컨벤션은 Google java style guide를 따른다.

직접 번역해볼까도 했으나, 이미 번역을 해주신 선배님(감사합니다)가 계시기에 링크만 적어두겠다.

https://github.com/JunHoPark93/google-java-styleguide

https://newwisdom.tistory.com/m/96