[Python] 주석, 들여쓰기, 행결합/행분리

🔗 출처

📘 Python 계단밟기

제01장 첫 번째 계단밟기

06. Python(파이썬) 기본

1. 주석
2. 들여 쓰기(indent)
3. 행결합/행분리

 

01. 주석

1. 주석이란?

프로그램의 실행에는 전혀 관여하지 않으면서 프로그램 코드 중간중간에 코드에 대한 자세한 설명을 첨부하는 것

 

 

2. 주석의 필요성

사용자가 만든 프로그램을 다른 사람에게 해석시키려면 적은 코드에도 적지 않은 시간과 노력이 소요된다.
실무에서는 혼자 프로그래밍하는 게 아닌 여러 사람이 팀으로 작업하기 때문에,
코드 해석 및 공유 시 주석을 달아놓아 코드 해석에 쓰이는 시간과 노력을 줄이기 위해서 쓴다.

 

 

3. 주석의 종류

• 블록 단위 : 작은따옴표(')를 연달아 세 개를 사용한다.

사용법 : ''' 주석처리 적용문장 '''
사용예
''' 주석처리 적용 문장 1
주석처리 적용 문장 2
주석처리 적용 문장 3
주석처리 적용 문장 4
'''

 

• 행 단위 : #을 사용한다.

사용법 : # 주석처리 적용 문장
사용예
# 주석처리 적용 문장 1
# 주석처리 적용 문장 2
# 주석처리 적용 문장 3

 

 

4. 주석의 사용 예

• Document String
  • 큰 따옴표(") 3개 를 연속으로 사용하여 주석으로 사용하는 것
  • 모듈, 함수, 클래스, 메서드 등을 만들 때, 자체 설명서를 등록하는 역할을 한다.
• Block comment
  • 작은 따옴표(') 3개 를 연속으로 사용하여 주석으로 사용하는 것
  • 일반적인 주석을 쓸 때 사용한다.
• 예

'''
프로그램명 : comment1.py
작 성 자 : 한 사 람
작 성 일 : 2018년 8월 1일
설  명 : 파이선에서 주석을 어떻게 처리하는지 보여주는 예제
'''

#  random 모듈을 사용할 수 있도록 포함한다.
import random

#-----------------------------------------------------------------
# 함수 정의 시작
def lotto():
    """
    로또 번호를 생성해 줍니다.
    ------------------------------
    호출 방법 : lotto()
    1~45사이의 정수 6개를 리스트로 리턴합니다.
    :return : <class 'list'>
    """
    # 1~45사이의 정수 중에서 6개를 무작위로 추출합니다.
    lotto =  random.sample(range(1,46),6)
    lotto.sort() #  오름차순으로 정렬합니다.
    return lotto # 결과를  호출항 곳으로 돌려줍니다.
# 함수 정의 끝

#-----------------------------------------------------------------
# 함수 호출하여 결과를 바로 출력합니다.
print(lotto())

# 도큐멘트 스트링 사용방법
print(lotto.__doc__)   # 도큐멘트 스트링 출력
help(lotto) # 도움말 함수 사용

 

실행 결과

[13, 16, 29, 33, 35, 45]

    로또 번호를 생성해 줍니다.
    ------------------------------
    호출 방법 : lotto()
    1~45사이의 정수 6개를 리스트로 리턴합니다.
    :return : <class 'list'>

Help on function lotto in module __main__:

lotto()
    로또 번호를 생성해 줍니다.
    ------------------------------
    호출 방법 : lotto()
    1~45사이의 정수 6개를 리스트로 리턴합니다.
    :return : <class 'list'>

 

---

02. 들여 쓰기(Indent)

1. 들여 쓰기(indent)

• 가독성을 위해 들여 쓰기를 한다.
• 다른 프로그램 언어에서는 {}을 사용하여 영역을 지정한다.
  • 하지만 파이썬에서는 들여쓰기를 사용하여 영역을 지정한다. (== 문법적인 강제 사항이다)
• 코드 블록을 구성하기 위해 if, for, class, def 등등을 작성하면서 나오는 콜론(:) 다음 아랫 줄은 반드시 들여 쓰기를 해야 한다.
  • 들여쓰기 방법 : 한 칸, 두 칸, 네 칸, 탭 등

** 중요한 것은 같은 블록 내에서는 들여쓰기 칸 수가 동일해야 한다.
위반 시에는 "IndentationError: unexpected indent"라는 에러를 출력한다.**

 

• 예

C언어 들여쓰기

 int factorial(int x) {
     if(x == 0)     {
         return 1;
     }     else     {
         return x * factorial(x - 1);
     }
 }

int factorial(int x){
    return (x==0) ? 1 :  x * factorial(x - 1);
}

 

Python 들여쓰기

def factorial(x):
     if x == 0:
         return 1
     else:
         return x * factorial(x - 1)

def factorial(x):
    return 1 if x==0 else x * factorial(x - 1)

 

---

03. 행결합/행분리

 

행결합 : 세미콜론(;)

• 많은 언어들이 구문이 끝날 때 문장의 뒤에 구문의 종료를 알리는 세미콜론(;)을 적는다.
• 하지만 파이썬은 구문이 끝나고 다음 줄로 내려갈 때 세미콜론이 필요 없다.
  • 줄이 바뀌면 자동으로 구분이 종료되었음을 인식한다.

** 세미콜론을 붙여도 에러는 나지 않는다. 여러 구문을 이어 쓸 때는 세미콜론을 쓰기도 한다**

 

• 예

# 세미콜론(semicolon) 사용법
print("Hello Python!!")	# Hello Python!!
print("Hello Python!!");	# Hello Python!!

print("첫번째 줄!!"); print("두번째 줄")
# 첫번째 줄!!
# 두번째 줄

print("첫번째 줄!!"); print("두번째 줄");
# 첫번째 줄!!
# 두번째 줄

 

 

행분리 : (역슬레쉬), 괄호

** 한 줄의 내용이 길어서 여러 줄로 타이핑해야 하는 경우에는, (역슬레쉬)나 괄호를 이용한다.**

# 긴 내용을 한줄인것 처럼 인식 시키기(\ 사용)
a = 1 + 2 + 3 + \
      4 + 5 + 6
      
# 긴 내용을 한줄인것 처럼 인식 시키기(괄호 사용)
b = (1 + 2 + 3 +
        4 + 5 + 6)
        
#  파라메터를 넘기는 것이라면 콤마(comma) 뒤에서 그냥 엔터를 쓰면 된다.
print("Hello",  "Python",
          end="\n", sep="\t")
# 결괏값
# Hello   Python

# 문자열 중간에 줄바꿈을 하면 자동으로 ""가 열고 닫히며 1줄로 인식한다.
print("아주 아주 아주 긴 문자열이라고 가정하자 " 
         "한줄에 모두 타이핑이 힘들다면")
         
# 결괏값
# 아주 아주 아주 긴 문자열이라고 가정하자 한줄에 모두 타이핑이 힘들다면