코드를 "잘" 짜보자

toss의 오픈소스들을 분석해서 내 코드에 도입하면 좋을 점들을 나열해 보자.

토스처럼 주석 쓰기

• jsdoc 형식
• 입출력 및 사용자 목적에 집중

/**
 * [함수 목적] - 이 함수가 하는 일에 대한 한 줄 설명
 *
 * @param param1 - 해당 파라미터의 의미
 * @param param2 - 해당 파라미터의 의미
 * @returns 리턴값 설명
 * @example
 * 실제 input // 실제 output
 */

구조적인 조건문

// 나쁜 예
if (type === 'error') return 'Error'
if (type === 'success') return 'Success'

// 좋은 예
const statusMap = {
  error: 'Error',
  success: 'Success',
}[type];

if 문을 늘리지 않아도 된다!

객체에 키/값 추가만 계속 해주면 되어서 보일러플레이트 없이 깔끔하게 유지 가능!
-> 단, 키/값 매칭되는 구조에 적합하고 비교문에는 별로인듯.

early return

내 경우는 if/else를 꼭 넣고 가능한 !를 넣지 않는 방향을 써서 앞 if문이 항상 뚱뚱했는데, return문을 먼저 넣는 쪽이 좀 더 가독성이 좋은 것 같다..!