오늘도 개발자 Backend Developer

좋은 코드 작성하기.

  • 개인적으로 개발을 하면서 좋은 코드를 작성하는 법을 고민하며, 작성한 글입니다.

1. 읽기 좋은 소스를 만들자.

  • 혼자 개발하는 프로젝트가 아닌 이상, 다른 사람이 내 코드를 보고 빠르게 이해할 수 있어야 한다.
  • var str_1 = ‘TEST_STRING_1’; var str_2 = ‘TEST_STRING_2’; 정말… 최악이다.

2. 불필요한 전역변수 사용

  • 특정 메소드에서만 사용하는 변수를 전역변수로 선언해 놓을 경우 소스 상단이 굉장히 지저분해 질 수 있다.

3. 적당한 주석

  • 주석 없이 작성된 코드를 한번에 이해할 수 있으면, 그 코드는 굉장히 잘 작성된 코드일 것이다.
  • 허나 실제로는 그렇게 하기 힘들다. 그러니 코드를 읽는데 최대한 방해되지 않게 해야 한다고 본다.
  • 주석보다는 명확한 변수명 또는 메소드명을 작성하여 개발 하는 걸 추천한다.
  • 추가적으로 업무 중에는 여러 이슈들에 의해서 예외처리, 하드코딩 등이 들어갈 수 있다. 그럼 어떤 이슈 때문에 작성된 코드고, 이슈 관리를 한다면 이슈 번호를 추가하여 다른 담당자가 해당 이슈를 찾기 쉽게 작성해 놓으면 업무하는데 있어서 굉장히 편하다.

4. 코드 컨벤션

  • 여럿이 여러 컨벤션을 사용하여 하나의 프로젝트를 진행한다면 최악의 사태가 발생할 수 있다.
  • A라는 개발자는 helloWorld 라고 변수를 만들고, B라는 개발자는 hello_world 로 만들어 사용한다면, 같은 목적을 가진 변수가 두개 존재하게 되고, 재활용을 못하게 된다.
  • 프로젝트를 진행하기전 camelCase( 각 단어의 첫 글자는 대문자를 사용(첫 단어는 소문자 사용)), underscores(각 단어를 밑줄로 구분한다) 등의 표기법을 잡고 시작하는걸 추천한다.
  • 또 formatter를 하나 만들어 공통된 코드 포멧을 사용할 수 있도록 하면 더더욱 좋다.

5. 리팩토링

  • 아 다음에 리팩토링해야지… 하는 생각은 버려라!
  • 조금씩이라도 꾸준히 리팩토링 해야한다.
  • 미사용 소스는 과감하게 삭제하고, 중복코드 또한 정리하는 걸 추천한다.
  • 추가 스팩이 발생하더라도 소스가 깔끔하게 정리되어 있다면 부담없이 추가 할 수 있을 것이다.

6. 코드리뷰

  • 혼자 작성한 코드보다는 여럿의 의견을 듣고 수정하는 코드가 더 좋을 수 밖에 없다.
  • 단, 코드리뷰시에 “비난”보다는 의견을 나누는 형태여야, 코드리뷰에 대한 스트레스가 없을 것이다.

7. 잘된 소스 보기

  • Spring 프로젝트 소스, Apache 프로젝트 소스 등을 틈틈히 읽어보다.
  • 아! 이렇게도 소스를 만들 수 있구나 싶은 부분들이 굉장히 많다.
  • 그러다보면 디자인 패턴은 기본적으로 배울 수 있게 되고, 여러 부분에서 도움이 많이 될 것이다.

* 좋은 코드 작성하는것에 대한 정답은 없는 것 같다. 단지 개발을 하면서 느낀 부분을 짧게 정리해 봤다.*