Coding Convention

나 혼자만 이해할 수 있는 코드는 좋지 않은 코드이다.
다른 개발자들도 쉽게 이해할 수 있는 코드가 좋은 코드이다.

클래스 (Class)

class http_request

• X

class HttpRequest

• O
• 대문자와 소문자 둘 다 사용
• 대문자는 단어를 구분하는 용도로 단어들의 첫글자만 대문자 사용
• 명사로만 구성
• _ 사용하지 않음

모듈 (Module)

import json
import re

from django.http import JsonResponse
from django.views import View
from users.models import User

• X

import json
import re

from django.http import JsonResponse
from django.views import View

from users.models import User

• O
• Django가 제공한 모듈과 직접 생성한 모듈을 띄어서 구분한다.
• 빈 줄은 관련이 있는 로직 단위로 삽입한다.

코드 정렬 (Code Align)

class User(models.Model):
    name = models.CharField(max_length=45)
    email = models.CharField(max_length=100)
    password = models.CharField(max_length=100)
    mobile = models.CharField(max_length=100)
    address = models.CharField(max_length=100)
    birth_date = models.DateField()

• X

class User(models.Model):
    name       = models.CharField(max_length=45)
    email      = models.CharField(max_length=100)
    password   = models.CharField(max_length=100)
    mobile     = models.CharField(max_length=100)
    address    = models.CharField(max_length=100)
    birth_date = models.DateField()

• O
• 코드의 줄을 잘 맞추면 코드가 깔끔하고 정리된 느낌을 준다.
• 코드의 가독성을 높여준다.
• 가장 긴 변수명 기준으로 변수명

테이블 명

class Meta:
	db_table = "user"

• X

class Meta:
	db_table = "users"

• database 테이블 명은 소문자, 복수 형태로 지정

앱 이름

python manage.py startapp user

• X

python manage.py startapp users

• 앱 이름은 복수