[5분공부] 파이썬 여러가지 팁

 

파이썬 코딩에앞서 여러가지 팁? 을 적어보았다.

파이썬 뿐만 아니라 거의 모든 코딩을 하는데 있어서 중요한(?) 것이기 때문에 살짝 알아두면 편할 것 같다.

 

1. 이름 규칙

코딩을 하다보면 엄청난 고민을 하게 되는 부분이다. 마치 자식의 이름을 짓는 느낌이랄까,,,

명명 규칙에는 대표적으로 4가지가 있다.

 

- 카멜 표기법 (Camel Case)

 JAVA 나 C# 에서 많이 쓰는 표기법이다.

 시작은 소문자, 이어지는 단어의 경우 각 단어의 첫글자만 대문자 로작성한다.

 ex) oneTwo

 

- 파스칼 표기법 (Pascal Case)

 카멜표기법과 비슷하지만, 첫 글자도 대문자로 작성한다.

 프로퍼티, 클래스 등의 이름을 지정할 때 쓰는데 이건 나중에..

 ex) OneTwo

 

- 스네이크 표기법 (Snake Case)

 언더바 표기법 (Under bar Case)라고도 한다.

 주로 C++ 에서 사용한다.

 ex) one_two

 

- 헝가리안 표기법 (Hungarian Case)

 접두어에 자료형을 붙이는 방식이다.

 ex) strOneTwo   => String 형식의 변수

 

일단 우리는 파이썬을 공부하고 있으므로, 파이썬에서 주로 사용하는 것은 스네이크 표기법 (언더바 표기법) 이다.

some_variable_name = 1
def some_function_name():
	print("Hello")
    
# 상수의 경우에는 모든 문자를 대문자로 작성해 준다.
SOME_CONSTANT = 3.14

 

이름을 지을 때에는 의미있는 변수와 함수의 이름으로 지어주어야 한다.

이 의미있는 이름 짓기 때문에 그렇게 고민을 ... ㅜ

# 나쁜 케이스
a = 3.14

def do_something():
	print("파이는 : ", a)
    
# 좋은 케이스
pi = 3.14
def print_pi():
	print("파이는 : ", a)

 

2. 띄어 쓰기

적당한 띄어쓰기와 줄 나눔은 코드를 읽기 편안하게 만들어 준다.

# 나쁜 케이스
print(1+1)
def print_func(a,b,c):
    print(a*b*c)

# 좋은 케이스
print(1 + 1)
def print_func(a, b, c):
    print(a * b * c)

 

변수와 함수 사이도 줄바꿈으로 나뉘어 주면 더 보기 좋다.

줄 바꿈의 정도는 개인의 차이이지만, 적당히 해주면 좋다.

def print_func(a, b, c):
    print(a * b * c)
a = 1
b = 2
c = 3
print_func(a, b, c)

# 위 보다 아래가 읽기 좋다

def print_func(a, b, c):
    print(a * b * c)

a = 1
b = 2
c = 3

print_func(a, b, c)

 

적당한 줄길이도 도움이 된다.

옆으로 긴 것 보다 위아래로 긴 것이 읽기 편하다.

print("1월, 3월, 5월, 7월, 8월, 10월, 12월은 " + str(31) + "일 4월, 6월, 9월 11월은" + str(30) + "일 2월은" + str(28) + "일")

print("1월, 3월, 5월, 7월, 8월, 10월, 12월은 " + str(31) + "일 "
       + "4월, 6월, 9월 11월은" + str(30) + "일 "
       + "2월은" + str(28) + "일")

 

3. 적당한 코멘트 (주석)

코멘트(주석)을 적절히 달아주면,

다른사람이 이 코드를 읽을 때나, 시간이 많이 지난 후에 내가 다시 코드를 읽을 때 도움이 된다.

주석의 적당한 정도는 사람마다 다르겠지만, 어느정도 작성해 두면 도움이 된다.

사람마다 적당함의 정도가 다르기 때문에 코멘트를 작성할 때에는 객관적인 시각으로 읽으면서 작성하면 도움이 된다.

# a 를 입력 받아 제곱한 수를 구하는 함수
def calc_square(a):
    # 제곱 = a * a
    return a * a
    
a = 5
calc_square(5)

 

오늘은 코딩에 있어서 중요하다면 중요한 세가지 팁을 알아보았다.

1. 명명 규칙 (이름규칙)

2. 띄어 쓰기

3. 적당한 코멘트