명명법

1. low camel case를 사용한다.
2. 함수명 → 동사+명사 순서로 작성한다.
3. 변수명 → 명사들의 결합으로 작성한다.

주석 규칙

1. 한줄은 //로 적고, 그 이상은 /** */로 적는다.

// 한줄 주석일 때
/**
 * 여러줄
 * 주석일 때
 */

2. 함수에 대한 주석

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

2. 하나의 파일의 시작 부분에 주석으로 상세 내용을 작성한다.

• 함수의 전체 기능에 대한 설명
• 함수의 파라미터에 대한 설명 (type: ..., 역할)
• router 또는 api일 때에는 성공 여부도 적어준다.
• 예시 코드

/**
 * @api {get} /study/:roomNumber/questions?sort_by=created&order_by=asc 방의 질문 목록을 가져옴
 * @apiName GetQuestions
 * @apiGroup Question
 *
 * @apiParam {String} roomNumber 유일한 방 번호
 *
 * @apiSuccess {Boolean} success API 호출 성공 여부
 * @apiSuccess {String} message 응답 메시지
 * @apiSuccess {Object} data 해당 방의 질문 리스트
 */
router.get(
  "/study/:roomNumber/questions",
  [checkParamAndQuery("roomNumber").isNumeric()],
  getQuestions.default
);

나중에 배울 apidoc에 쓰일 형식이다!

비동기 함수의 사용

Promise함수의 사용은 지양하고 async, await를 사용하도록 한다.

다만 로직을 짜는 데 있어 promise를 불가피하게 사용할 경우, 주석으로 표시하고 commit에 그 이유를 작성한다.

데이터 베이스 명명 규칙