파이썬 code convention (PEP 8)참고하여 작성
공백은 탭사용 !!!
한줄은 79자 넘지 않기
연산자 주변에 공백 1칸씩 넣기
a + b = c
함수호출이나 인덱스에는 공백x
user_list[1]
주석은 코드 위에 위치하기
문자열은 “”사용
변수/함수 네이밍은 소문자와 밑줄 (snake_case)
user_name
클래스 네이밍은 단어 첫글자 대문자 (CamelCase)
class User
상수 이름은 모두 대문자
PIE = 3.14
SECRET_KEY
임포트는 파일 제일 위에 작성
함수나 클래스에 대한 설명(독스트링) 바로 아래에 적기
클래스는 2줄, 함수는 1줄씩 띄우기
class MyClass:
def method_one(self):
pass
def method_two(self):
pass
다른 사람도 내 코드를 잘 이해할 수 있도록 주석 꼼꼼히 달기
테스트에 사용한 print문 지우기!
독스트링 (Docstrings)
함수나 클래스에 대한 설명을 독스트링으로 추가합니다. 독스트링은 함수 정의 바로 아래에 배치합니다.
def add_numbers(a, b):
"""
두 수를 더하여 결과를 반환합니다.
:param a: 첫 번째 숫자
:param b: 두 번째 숫자
:return: 더한 결과
"""
return a + b