From 30fccd8eb526b387aa53c5fd56a9997df712d690 Mon Sep 17 00:00:00 2001 From: hyungi Date: Mon, 28 Jul 2025 11:01:55 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=ED=8C=8C=EC=9D=BC=20=EA=B8=B8=EC=9D=B4?= =?UTF-8?q?=20=EB=B0=8F=20=EA=B5=AC=EC=A1=B0=EB=8F=84=20=EB=AC=B8=EC=84=9C?= =?UTF-8?q?=ED=99=94=20=EA=B0=80=EC=9D=B4=EB=93=9C=EB=9D=BC=EC=9D=B8=20?= =?UTF-8?q?=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 룰.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/룰.md b/룰.md index 85395e8..ffc4440 100644 --- a/룰.md +++ b/룰.md @@ -47,6 +47,18 @@ - 복잡한 로직이나 설명이 필요한 부분에 간결하고 명확한 주석을 작성합니다. - JSDoc 형식을 사용하여 함수/메서드의 목적, 파라미터, 반환 값을 설명하는 것을 권장합니다. +### 3.4. 파일 길이 가이드라인 + +- 가독성과 유지보수성을 높이기 위해 파일이 단일 책임을 갖도록 관리하는 것을 목표로 합니다. +- 파일의 길이가 **750줄**을 초과하기 시작하면, 해당 파일이 너무 많은 역할을 하고 있을 수 있다는 신호로 간주합니다. +- 이 경우, 파일을 역할(라우팅, 컨트롤러, 서비스, 모델 등)에 따라 분리하는 리팩토링을 적극적으로 권장합니다. + +### 3.5. 구조도 문서화 + +- 하나의 기능이 여러 파일(예: 컨트롤러, 서비스, 모델)로 분리되는 복잡한 구조를 가질 경우, 코드만으로 데이터 흐름이나 파일 간의 상호작용을 파악하기 어려울 수 있습니다. +- 이 경우, 기능의 메인 폴더나 관련 문서(`README.md` 등)에 **간단한 구조도나 설명**을 추가하여 다른 개발자들이 구조를 쉽게 이해할 수 있도록 돕는 것을 권장합니다. +- 간단한 텍스트 설명이나 `Mermaid.js`와 같은 도구를 사용한 다이어그램으로 구조를 명시합니다. + ## 4. API 개발 가이드 ### 4.1. 엔드포인트