기본기

이름 짓기 규칙

JABHACK 2024. 12. 5. 19:47

이름 짓기 규칙

항목 규칙/원칙 예시
클래스(Class) - 파스칼 케이스(PascalCase) 사용: 단어 첫 글자를 대문자로 시작.
- 명사 또는 명사구로 작성.
- 객체나 개념을 표현.
UserManager, OrderProcessor
인터페이스(Interface) - I로 시작하거나 클래스와 구분할 수 있는 명확한 이름 사용.
- 추상적인 동작을 나타냄.
IUserService, Orderable
메서드(Method) - 카멜 케이스(CamelCase) 사용: 소문자로 시작.
- 동작을 나타내는 동사형으로 작성.
- 명확하고 구체적인 동작을 표현.
getUser, calculateTotalPrice
변수(Variable) - 카멜 케이스(CamelCase) 사용.
- 의미가 명확한 명사형으로 작성.
- boolean은 is로 시작.
userList, totalCount, isActive
상수(Constant) - 대문자 스네이크 케이스(UPPER_SNAKE_CASE) 사용.
- 변경되지 않는 값을 표현.
MAX_RETRY_COUNT, DEFAULT_TIMEOUT
패키지/모듈 - 소문자로 작성하며, 필요하면 단어를 _로 연결.
- 짧고 구체적인 이름 사용.
user_management, data_utils
테스트 메서드 - should + 동작/조건 설명 형태로 작성.
- 테스트 목적이 드러나게 작성.
shouldReturnValidUser, shouldFailWhenInputInvalid
테스트 클래스 - 테스트 대상 클래스 이름 + Test 또는 Tests 접미사를 사용. UserServiceTest, OrderProcessorTests
테스트 폴더 - tests 또는 test 디렉토리로 명명. src/tests, project_name/test
파일/스크립트 - 짧고 명확한 소문자 형태로 작성.
- 필요하면 단어를 _로 연결.
app_config.py, user_service.js

 

 

'기본기' 카테고리의 다른 글

Clean Cord  (3) 2024.12.05