깨끗하고 이해하기 쉬운 유지보수가 쉬운 코드 작성 방법

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

웹 개발

대상자

• 소프트웨어 개발자, 팀 협업을 위한 실무 개발자
• 중간 수준의 개발자에게 유용한 실전 팁 제공

핵심 요약

• 변수/함수 이름은 목적과 유닛을 명확히 설명해야 하며, elapsedTimeInDays와 같은 명확한 이름 사용.
• 함수는 단일 책임 원칙 준수, 즉 하나의 작업만 수행하고, 인자 수는 2개 이하로 유지해야 함.
• 중복 코드는 재사용 가능한 함수/모듈로 추출하여 유지보수성 향상.

섹션별 세부 요약

1. 명확한 이름 사용

• var d; 대신 var elapsedTimeInDays;과 같이 목적을 명확히 설명하는 이름 사용.
• data, info와 같은 비구체적 단어는 이름에 포함하지 않음.
• class UserInfo 대신 class User와 같이 실제 역할을 반영한 이름 사용.
• yyyymmdstr 대신 currentDate와 같이 이해하기 쉬운 이름 사용.

2. 함수 설계 원칙

• 함수는 단일 작업만 수행해야 하며, isValidInsertion(column)과 같이 의미 있는 이름 사용.
• 인자 수는 2개 이하로 제한 (예: book(Customer customer, boolean isPremium) 대신 bookPremium(Customer customer)와 bookRegular(Customer customer)로 분리).
• 숨은 사이드 이펙트(예: Session.initialize())는 피해야 함.

3. 중복 코드 제거

• 반복되는 로직은 재사용 가능한 함수/모듈로 추출해야 함.
• 중복이 많은 코드는 유지보수성 저하와 버그 발생 위험 증가.

결론

• "Clean Code" 원칙을 따르면 팀 협업과 유지보수 효율성이 크게 향상됨.
• 명확한 이름, 단일 책임 원칙, 중복 제거는 코드 품질 향상의 핵심 전략.
• MAX_CLASSES_PER_STUDENT와 같은 명명된 상수 사용은 코드 가독성과 유지보수성을 높임.