[좋은습관] 코드 명명 규칙

1.깔끔한 코드 작성을 위한 핵심 습관 10가지

 

1-1.변수 및 클래스명은 명사 사용

동사 대신 명사를 사용하여 변수와 클래스명을 명확하게 합니다 (예: FeatureExtractor, worker).

class: FeatureExtract (X)
class: FeatureExtractor (O)

var: work (X)
var: worker (O)

var: log (X)
var: logger (O)

1-2.함수명에는 동사 포함

함수는 동작을 나타내므로 동사를 포함시키는 것이 적합합니다 (예: get_id(), train()).

function: id() (X)
function: get_id() (O)

function: trainer() (X)
function: train() (O)

1-3.변수명에서 관사 생략

굳이 관사를 사용하지 않고 간결하게 변수를 표현합니다 (예: a_cat 대신 cat).

var: a_cat (X)
var: cat (O)

 

1-4.전치사 최소화

변수명에서 전치사 사용을 줄이며, 필요한 경우 간결한 표현을 선택합니다 (예: num_workers).

var: the_number_of_worker (X)
var: num_workers (O)

 

1-5.단수와 복수 구분

변수명에서 단수와 복수를 구분하여, 코드의 가독성을 높입니다.

items = [1,2,3,4,5]

for item in items:
    print(item)

1-6.네이밍 컨벤션 따르기(중요)

사용하는 프로그래밍 언어의 네이밍 컨벤션을 따릅니다 (예: CamelCase, snake_case).

*네이밍 컨벤션(대표 5가지)

변수(snake_case)
:소문자로 시작, 중간에 _

 

폴더명(kebab-case)
:모두소문자, 중간에 -

 

상수(UPPER_CASE)
:모두 대문자, 중간에 _

 

함수(snake_case)
:소문자로 시작, 중간에 _

def print_hello(to):
    print('hello', to)

print_hello('data') #hello data

 

클래스(PascalCase)
:대문자로 시작, 중간에 대문자

class Calculator: #Calculator 클래스 선언
  def setx(self, x): #메서드 선언 #메서드 = 클래스내의 함수
    self.x = x
  def sety(self, y):
    self.y = y
  #
  def plus(self):
    return self.x + self.y

 

1-7.통상적인 변수명 사용

일반적으로 널리 사용되는 변수명과 규칙을 따릅니다 (예: temp, flag, num_items).

temp, obj, worker, num_somethings, count_somethings, flag, idx, is_condition, info, freq, token ...

 

1-8.상수는 대문자로 표시

변하지 않는 값의 상수는 대문자로 표기하여 명확히 합니다 (예: MAIN_WIDTH).

var: layer_size = 6 (X)
var: L = 6 (O)
var: main_width = 1024 (X)
var: MAIN_WIDTH = 1024 (O)
var: main_height = 768 (X)
var: MAIN_HEIGHT = 768 (O)

 

1-9.로직 후 공백 추가

같은 함수 내에서라도, 분명 여러 로직이 있습니다.

하나의 함수는 한 화면안에 모두 들어와야 된다라고 하며 모든 코드를 따닥따닥 붙여놓는 놓는것보다는

각 로직 단위 후 가독성을 위해 한 줄씩 공백을 추가합니다.

 

1-10.일관된 규칙 유지

위의 9가지 규칙 다 안 지키더라도, 네이밍과 코드에는 꼭 일정한 규칙이 있어야 합니다.

 

 

2.느낀점

좋은 코드를 많이 보고, 분석하여 자신만의 코딩 스타일(규칙)을 개발하는 것이 중요

변수명 명명시 신중하게 결정할 수 있도록 노력 해보자.

 

3.출처

https://sooftware.io/coding-habit/

Sooftware Coding - 좋은 코딩 습관 (네이밍)

https://velog.io/@rex/%EC%BD%94%EB%93%9C-%EC%9E%91%EC%84%B1-%EA%B7%9C%EC%B9%99%EB%93%A4-Coding-Conventions

코드 작성 규칙들 (Coding Conventions)