2023.03.22 약속

오늘은 심화과정 중에 학습한 것을 기반으로 다시한번 상기 시키고자

직접 적어보고자 한다 

코드컨벤션 중 파이썬의 pep-8이 언급됬는데

 

작업을 하다가 코드의 양이 방대해지면

비록 내가 한 것일지 언정 시간이 지나면 나조차도 알아보지 못할

가능성이 더러 있다고 한다 

이에 더해 보통 팀프로젝트로서 여러 사람이 다루게 되어 여러사람에게 읽혀지게 될텐데

그 사람들이 읽을 수 있도록 코드의 의도를 충분히 이해 할 수 있도록 하고자 하는 약속이

코드 컨벤션이라고 한다

 

코드컨벤션은 코드의 표기법에 관한것으로

그중 하나는 네이밍 컨벤션이 있다

대표적으로 세가지가 있다고 한다

Pascal Camel Snake 인데

Pascal은 각 단어를 대문자로 구별한다

Camel은 Pascal과 동일하지만 첫 문자가 소문자이다

Camel은 두가지로 나뉘게 되는데

Lower Camel case 첫 번째 문자가 소문자로 시작

Upper Camel case 첫 번째 문자가 대문자로 시작

Snake는 각 단어를 언더바(_)로 구별한다

 

파이썬에서는 Camel은 사용하지않고

함수를 네이밍할때 Snake, Class를 명시할때는 Pascal를 사용한다고 한다

 

이외에도 클래스, 함수, 변수의 이름을 정의할때

이 이름에서 내용을 추측 할 수 있도록 해야한다는 사항이 있고

그 외로는 다음과 같은 사항이 있다

• 상수를 표현할때는 예외적으로 모든 문자가 대문자로 표현한다
• 함수를 네이밍할때는 해당 함수가 어떤역할을 하는지 표현한다
• list를 표기할때는 복수로 표기한다 ex) number의 복수형으로 numbers 나 number_list 
• 반복문을 사용하여 가독성을 늘린다

넷 항목은 결국 코드의 직관성에 영향을 끼치는 것이다

코드가 실행되더라도 그 코드가 어떠한 방식으로 작동하는지 작동이 안돼는지를

직관적인 구성을 통해 파악하기 좋은 형태로 만드는 것이 좋은 코드가 아닌가 생각하게 된다