이 튜토리얼에서는 Python 프로젝트에서 따라야 하는 표준 스타일 가이드에 대해 배울 것입니다. 모든 프로그래밍 언어의 표준 스타일 가이드를 따르면 모든 팀원이 같은 속도를 유지할 수 있습니다. 게다가 프로페셔널해 보인다.
Python의 경우 대부분의 사용자는 PEP 8 스타일 가이드를 따릅니다. 코드가 더 보기 좋고 읽기 쉽습니다. 여기에서 스타일 가이드의 전체 목록을 찾을 수 있습니다. 이 기사에서는 선별된 스타일 가이드 목록을 제공합니다.
들여쓰기에 탭 사용
탭 사용 코드의 들여쓰기를 위해 여러 함수와 메서드에 임의의 공백을 사용하는 대신 코드를 더 읽기 쉽게 만듭니다. 모든 코드 편집기 설정에서 탭의 공백 수를 설정할 수 있습니다.
아래에서 몇 가지 예를 볼 수 있습니다.
# example def sample(random): # statement 1 # statement 2 # ... return random
Pythons의 기본 UTF-8 또는 ASCII 인코딩
Python의 기본 UTF-8 사용 또는 ASCII 인코딩은 국제 환경에 대한 모범 사례입니다.
튜플의 후행 쉼표
튜플에서 후행 쉼표를 사용하는 것은 모범 사례 중 하나입니다. 하지만 필수 사항은 아닙니다.
# example tup = (1, 2, 3,)
독스트링 사용
독스트링 사용 함수와 클래스에서. 독스트링에 대해 삼중 따옴표를 사용할 수 있습니다. 아래에서 몇 가지 예를 참조하십시오.
def sample(): """This is a function""" """ This is a function """ class Smaple: """This is a class""" """ This is a class """
한 줄에 79자 이상 쓰지 마세요.
PEP 8에서는 한 줄에 79자 이상을 작성하지 않는 것이 좋습니다. 스타일 가이드. 이스케이프 문자()를 사용하여 줄을 여러 줄로 나누어 이를 방지합니다. . 아래 예를 참조하십시오.
# example def evaluate(a, b, c, d): return (2 ** (a + b) / (c // d) ** d + a - d * b) \ - (3 ** (a + b) / (c // d) ** d + a - d * b)
공백 사용
연산자 앞뒤에 공백을 사용하는 것은 모범 사례 중 하나입니다. 가독성을 높이기 위해 쉼표 뒤에 공백을 사용합니다.
# example import random result = random.randint(1, 3) + random.randint(1, 2)
변수, 상수, 클래스 및 함수 이름 지정
프로그램 전체에서 변수, 상수, 클래스 및 함수에 대해 동일한 경우를 따르십시오. 대부분의 Python 사용자는 snake_case를 사용합니다. 함수 및 변수 이름 지정 및 PascalCase용 클래스 이름 지정을 위해. 상수의 경우 밑줄로 구분된 모든 대문자를 사용합니다(예:- PI_TWO ).
snake_case => this_is_function
PascalCase => ThisIsClass
상수 => THIS_IS_CONSTANT
한 번에 하나의 모듈 가져오기
구문상 올바르더라도 단일 모듈로 여러 모듈을 가져오려고 하지 마십시오. 아래 예를 참조하십시오.
# don't import math, random # do import math import random
댓글 업데이트
의견을 항상 최신 상태로 유지하십시오. 코드를 업데이트하는 동안 주석을 업데이트하는 것을 잊지 마십시오. 코딩에서 가장 중요한 것 중 하나입니다. 그리고 대부분의 사용자는 그것을 잊을 것입니다. 이 점을 명심하십시오.
변수 이름으로 단독으로 사용하면 안 되는 문자
변수 이름으로 사용해서는 안 되는 문자가 있습니다. 그리고 I(대문자 i), l(소문자 L)이 로마자와 비슷하게 생겼습니다.
식별자에 ASCII 문자를 사용하지 마십시오.
ASCII 사용 식별자에 문자를 사용하는 것은 좋은 습관이 아닙니다. 사용을 피하세요.