[주클] 주관적인 클린 코드 - formatting, import optimizing

이 시리즈는 어떤 코드가 좋은 코드일까라는 질문에 답하기 위한 저의 주관 100%의 시리즈입니다.
제가 생각한 것이 정답이 아닐 확률이 높습니다.
여러분들이 생각했을 때 더 좋은 방법이 있다 하시면 댓글로 달아주세요!

 

새로운 회사에 첫 출근 이후 코드를 새롭게 보고 있습니다.
여러 사람들의 코드가 이곳 저곳 섞여 있네요.
줄 맞춤이 좀 이상한데..? 다들 줄 맞춤도 다르고 Tab, Space가 섞여있네요..

 

제가 생각하는 클린 코드의 궁극적인 목표라고 하면 누가 봐도 보기에 편한 코드인것 같습니다. 어차피 클린(깨끗한)은 사람이 느끼는거지 기계가 느끼는게 아니니까요.

 

그래서 제가 요새 든 생각중에 하나는 업무를 시작할 때 코드의 포맷팅은 맞추고 시작해야한다고 느꼈습니다.

새로운 인원이 팀에 추가되면 모든 회사에서는 업무에 대한 설명과 구조에 대해 설명을 해줄겁니다.

 

하지만 제가 주변에 여기 저기 물어봐도 포맷팅 파일을 공유해준다던지 코드에 대한 공통적으로 지켜야할 점들은 공유가 잘 되지 않는다는 점입니다. 공유가 되더라도 지켜지지 않는 코드가 많은 것도 문제점인것 같습니다.

 

Formatting이 동일하지 않을 때 문제점

• 코드의 줄맞춤, Tab, Space 구분이 달라져 보기가 불편해진다.
• 다른 사람이 자동 포맷팅을 실행할 시 커밋에 불필요한 코드 라인들이 포함된다.
• 오랜 시간이 지나면 사용되지 않는 불필요한 코드가 늘어난다.

주관적인 클린 코드 방법

1. 공통화된 포맷팅 파일을 만든다. (IDE default, Custom file...)
2. 코드 작성 후 변경이 있는 파일에서 자동 포맷팅, import optimizing을 실행 후 커밋, 푸시한다.

IDE 단축키

• Intellij
  • Auto Formatting
    • Window : Ctrl + Alt + L
    • Mac : Cmd + Alt + L
  • Import Optimizing
    • Window : Ctrl + Alt + O
    • Mac : Cmd + Alt + O
• Eclipse
  • Auto Formatting
    • Window : Ctrl + Shift + F
    • Mac : Cmd+ Shift + F
  • Import Optimizing
    • Window : Ctrl + Shift + O
    • Mac : Cmd + Shift + O
• Visual Studio
  • Auto Formatting
    • Window : Ctrl + K + F
    • Mac : Cmd + K + F
  • Import Optimizing
    • Window : Shift + Alt + O
    • Mac : Shift + Alt + O