함수에 대한 주석

• backend에서 공통적으로 사용하는 함수의 경우, 모듈화를 통해 하나의 파일로 관리합니다.

• 하나의 파일의 시작 부분에 주석으로 상세 내용을 작성합니다. 정리해야 하는 부분은 다음과 같습니다.

• 보통 controller에 작성하기로 합니다

• 함수의 전체 기능에 대한 설명

• 예시 코드

  /**
   * @route GET /mission/all
   * @desc 지난 미션 모두 가져오기
   * */
   */
  const getCompletedMission = async (req: Request, res: Response) => {
    //어쩌구 저쩌구
  };
  

읽기 쉽고 알기 쉬운 변수명으로 만들기

// great - "name" implies strings
const subjectName = ['math', 'english', 'korea'];
const subject = [{name: 'math', difficulty: 'easy’}]

• boolean 같은 경우 “is”, “has”, “can”과 같은 접두어와 같이 사용한다.

// good
const isOpen = true; const canWrite = true; const hasFruit = true;

• 숫자일 경우 max, min, total과같은 단어로 설명한다.

// good
let totalNum = 54;

• 함수일 경우 동사와 명사를 사용하여 actionResource의 형식을 따르는 것이 좋다

// good
const getUser = (firstName, LastName) => firstName + LastName

변수(함수) 명에 대한 이름

• 변수, 함수 , 인스턴스 - Camel Case
• 함수명 작성 시 동사 + 명사
• Class, Constructor - Pascal Case