[개발이야기] 코드컨벤션 설정

---

✨[개발이야기] 협업을 위한 코드컨벤션 설정✨

---

변수(함수) 명에 대한 네이밍 컨벤션

• 변수, 함수, 인스턴스를 작성할 때는 카멜케이스를 사용한다.

 

최대 tab depth 제한

• tab의 최대 depth는 4로 제한하는 것이 좋다.
• 만약 개선할 수 없다고 판단되는 경우, 팀원들과의 코드 리뷰를 통해 개선해나가도록하자!

function func () {
  //tab1
  if() {
    //tab2
    array.reduce((pre, cur) => {
      //tab3
      if(cur == status) {
        //tab4
       }
     }
   }
 }

 

주석 규칙

• 한 줄은 //로 적고, 그 이상은 /** */로 주석을 작성한다.

// 한 줄 주석일 때

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

 

함수에 대한 주석

• backend에서 공통적으로 사용하는 함수의 경우, 모듈화를 통해 하나의 파일로 관리한다.
• 하나의 파일의 시작 부분에 주석으로 상세 내용을 작성한다.

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

/**
 * 빌딩 리스트와 ID 값을 받는다.
 * @param {String} buildings 빌딩 리스트
 * @param {Number} id 빌딩의 ID
 */


export default async function isCurrentBuildings(buildings, id){

}