Coding Style Guide

[hskhyl]

1. 함수 및 클래스 Docstring:

• 타입 힌트:
• 기능 설명: 함수나 클래스가 하는 일을 간단히 설명.
• 인자 설명: 함수 인자와 타입, 목적 설명.
• 반환값 설명: 반환값의 타입과 의미 설명.
• 예시

class Calculator:
 """
 간단한 계산기를 나타내는 클래스.

 이 클래스는 기본적인 산술 연산(덧셈, 뺄셈, 곱셈, 나눗셈)을 제공
 """

 def subtract(self, a: float, b: float) -> float:
     """
     두 숫자의 차를 계산

     Args:
         a (float): 첫 번째 숫자.
         b (float): 두 번째 숫자.

     Returns:
         float: 두 숫자의 차.
     """
     return a - b

2. 주석 작성:

• 한 줄 주석:
  코드와 주석 사이 최소 두 칸 띄우고 # 사용.
• 여러 줄 주석:
  최대한 피하되 논리적 구조가 연속되는 if-else 와 같은 구조에서 기능의 시작코드 바로 윗 줄에서
  여러줄의 설명을 한번에 끝냄

3. 네이밍 규칙:

• 변수:
  소문자 + 밑줄(my_variable).
• 상수:
  대문자 + 밑줄(MY_CONSTANT).
• 클래스:
  카멜케이스(MyClass).
• 함수:
  소문자 + 밑줄(my_function).

4. 클래스, 함수 간에 띄어쓰기

• 독립적인 함수, 클래스 간:
  두 줄
• 클래스 안의 메서드 간:
  한 줄