파이썬(Python) 이론 공부 - 코드 컨벤션

20240628

• 코드 컨벤션(Code Conventions) 

협업(팀 프로젝)과 유지 & 보수를 위한 코드 작성 규칙  ▶ 스타일을 통일하자는 "약속"

 

ex) 파이썬의 PEP 8(Python Enhancement Proposal 8) 등

 

• 파이썬에서 요구하는 코드 컨벤션

1. 네이밍 컨벤션( Naming Conventions ) - 이름만 보고도 해당 코드가 어떤 걸 의미하는지 추측하기 위한 규칙

 변수 / 함수를 네이밍 할 때는 Snake 표기법을, Class를 네이밍 할 때는 Pascal(  upper camel ) 표기법을 사용

 

Pascal ( upper camel ) : 각 단어를 대문자로 구별. 카멜 표기법과 혼용해서 사용하는 경우도 있지만, 일반적으로 (Microsft 등)은 "low calmel"만 카멜 표기로 사용. 파이썬에서는 Class를 네이밍 할 때 사용. 

ex.) UserChoice

 

Snake : 각 단어를 언더바( _ )로 구분. 변수 / 함수를 네이밍

(ex.) number_sum 등 

 

 

* 상수를 표현할 때는 예외적으로 모든 문자를 대문자로 표현  ex). PIE = 3.14 

 * list를 표기할 때는 복수로 표현.

 

2. 코드 레이아웃 (Code Layout)- 구획을 나누고 적절히  코드를 배치하는 것

 

들여쓰기 - 공백 4칸 또는 tap 한 번 사용

 

라인 길이 - 한 줄의 길이가 79자 또는 80자로 제한(가독성을 위해)

 

공백 사용- 연산자 & 키워드 주위는 적절한 공백(가독성을 위해)

 

 

3. 주석(Comments) - 코드의 동작 또는 목적을 명확히 설명

 

 

주로 한 줄 주석(#)과 여러 줄 주석(''' 또는 """)을 사용함.

 

주석 위치: 함수와 클래스 정의의 위에 설명 주석을 추가 또는 복잡한 코드 블록 안에는 인라인 주석 추가.

 

 

 

파이썬을 공부하면서 들여쓰기나 주석에 대한 것은 알고 있었다. 하지만 네이밍도 규칙이 있는지는 오늘 알았다. 생각해 보면 그저 지금 편하게 하려고 알파벳으로 간단하게 정의(ex. a , b, sd 등) 하거나 한다면 지금은 빨리 코딩하고 편하겠지만 나중에는 스스로도 기억하기 힘들고(유지&보수), 팀프로젝트라면 오히려 더 시간이 많이 들 것 같다고 느꼈다. 역시 의미 없는 것은 없다는 걸 알게 되었다.