클린 코드

무분별하게 주석 달지 말기

주석은 정책 사항 위주로!

여기서 정책 사항은 기획서나 요구 사항에 적혀있는 항목으로써, 매번 바뀌는 전세법처럼 코드가 아닌 코드 외부의 정보나 지식이 있어야 알 수 있는 내용들을 말한다. 동작은 주석을 달 필요가 없는데, 메서드 이름에 그 목적을 담아 표현해서 전달하면 되기 때문이다. 코드가 아닌 한글로 대화하는 것은 지양해야 한다. 주석을 달 때는 정말 이 주석이 필요한지, 코드로 대체가 가능하지는 않은지 잘 고민하고 작성해야 한다.

 

코드 리뷰/리펙토링

반복 개발 연습은 필수이다. 변수명 하나도 의도가 잘 전해지도록 신중하게 정해야 한다.

 

Early Return

성능면으로도, 가독성으로도 이득이 된다.

 

SRP

를 제대로 지키자. 여기서 단일 책임의 기준은 Actor, 즉 사용자이자 기능의 동작자 기준에서 하나의 책임 또는 기능을 실행할 수 있는 단위를 말한다. 

 

클라이언트 개발자와 대화 잘 하는 법

RESTful 한 API를 개발해야 한다.

목적성 있는 서버에서 목적성 있는 api를 잘 작성해야 한다.

API 명세서로 주로 협업을 하는데,

Swagger를 이용하면 더 편리하게 개발 진행이 가능하다.

 

Code Analyzer

- sonarQube : 정적으로 코드들 상태 검진, 리포트 해주는 도구

- sonarlint