협업하기 좋은 코딩 스타일이란?

#코멘토 #코멘토실무PT #실무PT후기 #실무강의 #리액트강의 #웹프로그래밍 #react #웹개발실무

필수 링크
https://bit.ly/3D9XCOz

코드를 잘 짠다는 것은?

남을 위한 코드 만드는 것!!
우리는 늘 협업하고, 내가 회사를 떠난다면 누군가는 이 코드를 유지보수한다.

클린 코드를 위한 중요 5가지

1. 네이밍 컨벤션 준수

• 클래스명은 명사를 사용하며 의미가 드러나는 이름을 짓는다.
• 변수는 의도가 드러나게 작성한다.
• 함수는 객체의 동작을 의미하므로 동사를 사용하여 이름을 짓는다.
• 멤버 변수, 인자명, 로컬 변수명은 lowerCamelCase 방식을 따른다.
• 상수명은 CONTANT_CASE 방식을 이용한다.

2. 주석 관리

• 불필요한 주석을 제거하고 의도를 명확하게 관리한다.
  1. 중복 주석 제거
     • 코드로서 의도를 직관적으로 파악할 수 있다면, 주석을 남기지 않아도 된다.
  2. 정보 제공 주석
     • 코드에서 강조할 부분이 있거나, 직관적으로 파악할 수 없다면 정보 제공 주석을 남겨야 한다.
  3. 할일 주석
     • 추후에 추가 구현이 필요할 때, 유용하게 사용 가능하다.

3. 코드 복잡도 관리

• 좋은 개발자는 사람이 이해하기 쉬운 코드를 작성한다.
  • 주기적인 리백토링으로 점진적 개선하여
  • 낮은 복잡도의 코드가 되도록 한다.
• 역할이 분명한 코드
  • 클래스는 한가지 역할 만을 수행 하도록 한다.
• 형식을 갖춘 코드
  • 한 줄당 80 ~ 120자 정도의 길이로 제한하고 적절한 들여쓰기를 고려한다
  • 서로 밀접한 개념은 한 파일에 세로로 가까이 둔다.
  • 변수는 사용하는 위치에서 가장 근접한 위치에 선언한다.

4. 코드 품질 관리

• 예외 관리
  • 오류를 발생 시키지 말고, 예외문을 발생 시켜 간결한 코드를 유지 하도록 한다.
• 테스트 관리
  • 버그 주변은 철저히 테스트 하여 코드 안전성 확보
• 경계 조건 테스트
  • 테스트 커버리지 높임 : 단위 테스트가 가능 하도록 테스트 가능한 코드를 작성한다.

5. 클린코드 원칙 적용

참고 자료

• Airbnb JS Style Guide : https://github.com/airbnb/javascript
• Naver JS Style Guide :
  https://github.com/naver/eslint-config-naver/blob/master/STYLE_GUIDE.md
• JS 클린 코드 :
  https://github.com/qkraudghgh/clean-code-javascript-ko