이것은 파이썬 공식 가이드인 PEP-8과 구글 파이썬 코딩 스타일을 참조하였다.

코드는 가독성이 중요하다

• 깔끔한 코딩 스타일
• 간단하고 명료한 로직
• 명확한 변수, 함수, 클래스 등의 이름

Naming

변수, 함수, 클래스, 모듈, 패키지의 이름은 최대한 한 눈에 그 목적을 이해 할 수 있는 이름을 선택하는 것이 좋다.

Naming Anti Pattern

• 특별한 의미가 없거나 목적이 불분명항 이름들:

-object = User()
-list =[1,2,3,4,5]

• 너무 자세하거나 긴 이름들:

• user_who_is_created_now = User()

• list_of_integer_numbers_that_are_less_than_five = [1, 2, 3, 4]

너무 짧은 이름들

• u = User()
• l = [1, 2, 3, 4, 5]
• i = 7

단어 절차를 짧게 만든 이름들:

• trd = Trader()
• nums = [1, 2, 3, 4, 5]

Space

Space(빈 줄)을 사용하는 것에도 암묵적으로 지켜지는 convention이 있습니다.
처음 배우실 때 많이 실수 하시는 부분이 여러 빈 줄을 삽입하는 경우 입니다.

일반적으로 빈 줄은 하나만 삽입 합니다 (어떤 가이드들은 클래스와 클래스 사이는 2줄의 빈 줄을 삽입하라고 안내하는 가이드도 있지만 저희는 기본적으로 빈 줄은 하나만 사용합니다).

또한 빈줄은 관련이 있는 로직(login) 단위로 삽입 합니다.

예를 들어, 같은 함수라도 함수를 구성하는 로직은 여러 부분으로 나뉠 수 있습니다. 이러한 부분 사이에 빈 줄을 삽입 해주시면 됩니다.

코드가 한줄에 너무 길게 있을때

일반적으로 한 줄에는 79자를 안넘어가도록 코드를 작성합니다. 한 줄에 79자를 넘어가면 다음줄로 나누어서 작성하는것이 일반적인 가이드 입니다.

그래서 79자가 아니더라도 한 눈에 봤을때 부담스럽다면 다음줄로 나누어서 작성하여 가독성을 높이는 것을 선호합니다:

Code Align

---

일상에서도 "줄"을 잘 맞추고 "각"을 잘 맞추면 깔끔하고 정리된 느낌을 줍니다.

코드도 마찬가지 입니다. Align, 즉 줄을 잘 맞추면 코드가 깔끔하고 정리된 느낌을 줌으로 읽는 사람이 더 편하게 읽을 수 있도록 해줍니다.

물론 매번 직접 align을 해야 한다면 너무 일이 많고 힘들 것입니다.

그래서 vim은 자동으로 align을 해주는 Align이라는 플러그인이 있습니다.

Vim을 사용안하는 사람들은 어떻하냐고요? 지금 부터 vim을 사용하시면 됩니다 😄