코드 컨벤션 소개

파트너플랫폼 스쿼드는 코드 컨벤션을 통해 팀의 효율성을 높이고자 합니다. 코드 컨벤션은 개발팀이 일관된 방식으로 프로그램을 작성하고 유지 보수하기 위한 규칙과 가이드라인을 의미합니다. 이 글에서는 코드 컨벤션의 중요성과 주요 원칙을 소개합니다.

코드 컨벤션의 중요성

• 가독성 향상: 일관된 코드 스타일은 코드의 가독성을 높입니다.
• 유지 보수성 향상: 공통 규칙을 통해 버그를 빠르게 수정할 수 있습니다.
• 팀 협업 강화: 일관성 있는 코드 스타일은 원활한 협업을 돕습니다.

주요 원칙

• 편집 설정: .editorconfig 파일을 활용해 통일된 설정을 관리합니다.
• 패키지 구조: 명확한 패키지 구조로 서비스 확장 시 용이함을 제공합니다.
• 명명 규칙: 의미 있는 이름 사용으로 코드의 가독성을 높입니다.
• URI 디자인: 일관된 URI 구조로 API 사용을 용이하게 합니다.
• 응답 코드 규칙: 일관된 응답 코드로 클라이언트의 이해를 돕습니다.