코딩 컨벤션은 읽고, 관리하기 쉬운 코드를 작성하기 위한 일종의 코딩 스타일 규약이다.
코딩은 혼자 완성하는 것이 아니며 팀원들과 함께 하는것인데 자기에게만 알아보기 좋은 코드는 좋지않다.
다른 개발자들도 쉽게 이해할 수 있는 코드가 좋은 코드 이다.
개발이란 과정은 대체로 새 코드를 짜는 것보다 유지보수가 더 중요한데 가독성이 떨어지는 코드는 유지보수를 어렵게 만든다.
_
을 쓰지 않는다특별한 의미가 없거나 목적이 불분명한 이름들:
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]
vs code같은 에디터에서도 포맷팅해주는 기능이긴 하지만 단어가 많아 가독성이 떨어진다면 79자가 안되더라도 줄을 나눠서 입력하는게 좋다. 요즘은 모니터가 커졌기 때문에 100자 정도까지는 많이 허용하는 듯 하다.
딕셔너리 같은 자료형을 이용할 때 코드를 정렬하면 가독성이 훨씬 좋아진다 또한 임포트문도 정렬하면 좋다
vs code의 better align 확장프로그램을 설치하면 =나 :이 들어가는 코드를 쉽게 정렬해준다.
# 정렬을 하지 않은 코드
import django
from something import awesome
from math import random
import requests
new_user = User()
new_user.name = user["name"]
new_user.age = user["age"]
new_user.feature = "?"
user = {
"id" : 1,
"name" : "아이유",
"age" : 27,
"gender" : "Female",
"occupation" : "Artist"
}
# 정렬한 코드
import django
import requests
from something import awesome
from math import random
new_user = User()
new_user.name = user["name"]
new_user.age = user["age"]
new_user.feature = "?"
user = {
"id" : 1,
"name" : "아이유",
"age" : 27,
"gender" : "Female",
"occupation" : "Artist"
}
위 내용 외에도 소속된 팀에서 정한 규칙이 있다면 그걸 따르면 된다.
같은 내용이지만 가독성이나 성능 등을 고려해서
if a == None, if a != None: # 비추
if a is None, if a is not Non:e # 추천
if not a is None: # 비추
if a not in b: # 추천
if not a in b: # 비추