[TIL] 20241129 TIL

Jaeyoung Ko·2024년 11월 29일

오늘은 풋살 온라인 팀 프로젝트를 하기에 앞서 팀 회의 및 이전 과제 RECAP에 대한 내용이 주된 일이었다.

우선 코드 컨벤션에 대해서

협업에 있어서 서로의 코드에 대해 가독성이 매우 중요하고,

유지 보수가 편한 구조로 만드는 게 중요하기 때문에

일관성있는 코드 컨벤션을 사용할 수 있도록 소통을 나눴다.




Code Convention

1) Naming
대부분 변수 : camelCase 통일 (snake, Pascal 지양)
.env, cofig, enum 에 대해선 UpperSnake
2) Multiline Formatting
열거된 데이터/객체에 대해선 line break로 가독성 높이기
3) Commnet 주석: Block Comment 형식
코드의 오른쪽이 아닌, 기능 상단/ 라인 상단에 주석 추가

/*
    컨밴션 예시
*/
    const testString = "이런 식으로 카멜케이스 작성합니다.";
    // 주석은 기능 상단 위에
    loggers.error({
        message: '[Error] error occurred',
        error: err.message,
        stack: err.stack,
    });
    // 열거할 때는 멀티라인, enum은 Upper Snakecase
    enum Status {
        ACTIVE,
        INACTIVE,
    }



그 이외에는 역할 분담 및 약간의 DB 모델링에 대한 이야기를 나눴다.

아직까지는 DB 모델을 확정짓지 못한 상태로,

내가 브루트 포스하게 생각한 구조는 대충 위와 같다.

하지만 설계/명세/기획이 개발을 위해서 매우 중요한 단계인 만큼 다시 수정할 계획이다.

profile
안녕하세요, 고재영입니다. 언제나 즐겁게 살려고 노력합니다.

0개의 댓글