웹 퍼블리셔 실무 TIP

협업을 위해 꼭 필요한 주석 & 가독성 좋은 코드
특히 인하우스 퍼블리셔인 경우 퍼블리셔가 혼자인 경우가 대부분이기 때문에
개발자와 협업을 위해 좋은 주석 & 코드는 필수라고 생각한다.
해당 게시글은 실무를 하며 배운 Tip들은 모아 둔 곳이다.

사실 나도 계속 까먹어서 계속 꺼내보기 위해 만든 repo 🥰💕

1.  주석이 필요없는 가독성 좋은 코드가 BEST이지만 정보가 필요한 곳에는 주석 필수!

👉 정보를 제공해주는 주석 예시 : RegExp, 설명이 필요한 함수 등 

2. 조건문에서 부정이 아닌 긍정 다루기

👉 별 거 아닌데 은근히 중첩되는 반복문이 많아진다.

const [isHoliday, setIsHoliday] = useState(true);

// DON'T DO THIS 🤦‍♀️💫
if(!isHoliday) console.log('일 하러 가야지...🏃‍♀️')

// DO THIS 🙆‍♀️✨
if(isHoliday) console.log('휴가 넘 좋아🙆‍♀️');

• DON'T DO THIS 부분을 보면 isHoliday는 boolean(긍정)이다. 근데 !isHoliday를 하면서 긍정이 부정이 된다.  이런 간단한 예시에서는 바로 알아 볼 수 있지만 코드가 복잡해지면 이게 그래서 부정인데 긍정인데 부정인가? 라는 생각에 빠질 수도 있다.

3. 함수 이름은 명확하면 명확할수록 좋다!

• 함수의 이름은 동사로 시작하며 현재형으로 작성
  예시) fetch, search, create
  👉 더 많은 동사는 이곳에서 확인! 이곳도!

동사	뜻
can / has / is	boolean 리턴
get	boolean이 아닌 값 리턴
set	값을 저장하는 함수

출처 : JavaScript Naming Convention

 

계속 추가 중 🐬🌫