1단계 : 3. 첫번째 프로그램: Hello, World! (feat. 코드 작성 규칙, 들여쓰기, 주석 활용법)

 

Python은 간결하고 읽기 쉬운 문법으로 유명한 언어입니다. 하지만 Python 코드 작성 시 반드시 지켜야 하는 규칙이 있습니다. 특히 들여쓰기와 주석 활용법은 가독성 있는 코드와 오류 없는 프로그램을 작성하는 데 중요한 역할을 합니다. 이 장에서는 Python의 코드 작성 규칙과 이를 실습에 적용하는 방법을 살펴보겠습니다.

 

 

1. Python의 들여쓰기 (Indentation)

 

 

㉮ 들여쓰기란?

 

들여쓰기는 코드의 계층 구조를 명확히 하기 위해 사용하는 공백입니다. Python은 들여쓰기가 필수적이며, 이를 잘못 작성하면 코드가 실행되지 않거나 오류가 발생합니다.

 

㉯ Python에서 들여쓰기의 역할

   • 블록 구조 구분: 조건문, 반복문, 함수 등 코드 블록을 구분합니다.

   • 오류 방지: 들여쓰기를 제대로 사용하지 않으면 Python은 문법 오류를 발생시킵니다.

 

예제: 올바른 들여쓰기

if True:
    print("Hello, World!")  # 들여쓰기된 블록

 

예제: 잘못된 들여쓰기

if True:
print("Hello, World!")  # 들여쓰기 없음

 

결과:

IndentationError: expected an indented block

 

 

㉰ 들여쓰기 규칙

 

  ⓐ 공백 사용: 일반적으로 4칸의 공백을 사용합니다.

  ⓑ 혼합 금지: 공백과 탭을 혼용하지 않습니다.

  ⓒ 코드 정렬: 같은 블록의 코드들은 동일한 수준으로 들여쓰기를 맞춥니다.

 

 

2. Python의 주석 활용법

 

㉮ 주석이란?

 

주석은 코드에 대한 설명을 추가하여, 코드의 의도를 명확히 하거나 다른 개발자에게 정보를 전달하기 위해 사용됩니다. Python은 주석으로 처리된 부분을 무시하고 실행합니다.

 

㉯ 주석의 종류

 

한 줄 주석

   • # 기호를 사용하여 한 줄을 주석 처리합니다.

   • 주석은 코드의 기능을 간단히 설명할 때 유용합니다.

# 이 코드는 "Hello, World!"를 출력합니다.
print("Hello, World!")

 

여러 줄 주석

   • 여러 줄의 주석을 작성할 때는 일반적으로 문자열 블록(""" 또는 ''')을 사용합니다.

   • 문서화 주석(docstring)에도 활용됩니다.

"""
이 프로그램은
"Hello, World!"를 출력하는 코드입니다.
"""
print("Hello, World!")

 

㉰ 주석 작성 규칙

 

  ⓐ 필요한 곳에만 작성: 주석이 너무 많으면 가독성이 떨어질 수 있습니다.

  ⓑ 간결하고 명확하게 작성: 불필요한 설명은 피하고, 핵심 내용을 전달합니다.

  ⓒ 영어 또는 한글 사용: 팀의 언어 규칙에 따라 작성합니다.

 

 

3. 코드 작성 규칙 적용 예제

 

 

다음은 Python의 들여쓰기와 주석을 활용한 간단한 예제입니다.

 

예제 코드: 주어진 숫자가 양수인지 확인

# 입력된 숫자가 양수인지 확인하는 프로그램
def check_positive(number):
    """
    함수 설명:
    입력받은 숫자가 양수인지 아닌지 확인합니다.
    Args:
        number (int): 입력된 숫자
    Returns:
        str: 결과 메시지
    """
    if number > 0:
        # 입력된 숫자가 양수일 때
        return "양수입니다."
    elif number == 0:
        # 입력된 숫자가 0일 때
        return "0입니다."
    else:
        # 입력된 숫자가 음수일 때
        return "음수입니다."

# 함수 호출
result = check_positive(-5)
print(result)  # "음수입니다." 출력

 

 

 

4. 잘못된 들여쓰기와 주석 예제

 

잘못된 들여쓰기

def add_numbers(a, b):
return a + b  # 들여쓰기 부족

 

결과:

IndentationError: expected an indented block

 

잘못된 주석

# 이 프로그램은 모든 숫자를 다 더하고 곱하고 나누고
# 결과를 보여줍니다. 그러나 예외 처리는 아직 구현되지 않았고
# 향후 버전에서 추가될 예정입니다. 지금은 기본적인 연산만
# 수행하며 에러가 발생할 수 있습니다.
def add_numbers(a, b):
    return a + b

문제점: 불필요한 설명이 많아 코드 가독성을 떨어뜨립니다.

 

 

5. 실전 팁: 가독성을 높이는 코드 작성

 

㉮ 들여쓰기 자동화

 

   • PyCharm과 같은 IDE를 사용하면 들여쓰기를 자동으로 관리할 수 있습니다.

   • 잘못된 들여쓰기는 IDE가 경고를 표시합니다.

 

 

6. 요약

 

Python 코드 작성에서 들여쓰기와 주석은 가독성과 코드 품질을 결정짓는 중요한 요소입니다.

 

   • 들여쓰기는 4칸의 공백을 사용하며, 블록 구조를 명확히 구분합니다.

   • 주석은 코드의 의도를 명확히 전달하며, 간결하고 명확하게 작성해야 합니다.