명명법 가이드: 효율적인 코드 작성 규칙

 

코딩 작업에서 명명법은 코드 가독성을 높이고 유지보수를 쉽게 만드는 중요한 요소입니다. 이 글에서는 개발 프로젝트에서 활용할 수 있는 명확한 명명 규칙(Naming Convention) 을 소개합니다. 특히 Python 및 PyQt6 개발 환경에 적합한 명명법을 중심으로 다룹니다.

---

클래스 및 함수 명명 규칙

1. 클래스 이름
   • 접두사: wC_ (Widget Class의 약자)
   • 형식: PascalCase (단어 첫 글자를 대문자로 작성)
   • 예시:
     • wC_LoginForm
     • wC_DataHandler
2. 함수 이름
   • 반환값이 있는 함수: F_로 시작
   • 반환값이 없는 함수: P_로 시작
   • 외부에서 사용 가능한(public) 함수:
     • uF_ (반환값 있음)
     • uP_ (반환값 없음)
   • 예시:
     • uF_GetUserData()
     • P_SaveToDatabase()

---

변수 명명 규칙

1. 지역 변수
   • 접두사: v
   • 데이터 타입에 따라 접두사 추가:
     • Boolean: vIs_
     • String: vS_
     • Integer: vI_
   • 예시:
     • vIs_Connected = True
     • vS_UserName = "John"
     • vI_MaxRetries = 5
2. 클래스 변수
   • 접두사 생략: self.를 바로 사용
   • 예시:
     • self.UserList
     • self.Is_Active
3. 파라미터
   • 접두사: x (Parameter를 의미)
   • 예시:
     • xUserId, xOptions

---

반복문 변수 명명 규칙

• 기본 반복문 변수: i
• 중첩 반복문 변수: ii, iii 등
• 예시:

  for i in range(10):
      for ii in range(5):
          print(i, ii)

---

상수(Constant) 명명 규칙

• 형식: 모두 대문자, 단어 간 _ 사용
• 예시:
  • MAX_RETRIES = 3
  • DEFAULT_TIMEOUT = 30

---

추가 개발 규칙

1. 신호 정의 (pyqtSignal)
   • Signal_On_으로 시작
   • 예시:
     • Signal_On_DataChanged = pyqtSignal()
2. 예외 처리 및 오류 복사 기능
   • 모든 함수에 예외 처리 추가.
   • 오류 발생 시 클립보드에 복사하는 버튼 구현.
3. 파일 분리
   • 각 클래스 및 함수는 별도의 파일에 작성하여 유지보수 용이.
4. 디버깅
   • 코드에 디버그 메시지 추가로 문제 해결을 간소화.

---

결론

이 명명법 가이드는 Python 및 PyQt6 프로젝트를 효율적으로 관리하는 데 유용합니다. 명확한 규칙을 적용함으로써 협업과 유지보수를 더욱 수월하게 할 수 있습니다. 더 많은 코딩 팁과 개발 가이드를 원한다면 이 글을 북마크하고 활용해보세요!