Ruby 입문 기초

Ruby 루비의 주석 사용법

Ruby 루비의 주석 사용법 — 초급

루비의 주석 사용법

1. 도입 (왜 배워야 하는가)

주석은 소스 코드 내에 포함되어 있지만, 프로그램의 실행에는 영향을 미치지 않는 텍스트입니다. 주석을 사용하는 것은 소스 코드를 작성하는 데 있어 매우 중요합니다. 실무에서는 여러 사람이 같은 코드를 읽고 수정해야 하는 경우가 많기 때문에, 주석이 없으면 코드의 의도를 이해하기 어려워질 수 있습니다. 주석이 없을 경우, 새로운 개발자가 코드를 이해하는 데 오랜 시간이 걸리거나, 잘못된 수정이 이루어질 위험이 있습니다.

예를 들어, 쇼핑몰의 장바구니 관리 코드를 작성한다고 가정해 보겠습니다. 주석이 없다면, 다른 개발자는 왜 특정 코드가 필요한지 이해하지 못하고, 이로 인해 중요한 기능이 손실될 수 있습니다.

2. 핵심 개념 설명

주석은 크게 두 가지로 나눌 수 있습니다:

한 줄 주석: # 기호를 사용하여 코드의 한 줄에 대한 설명을 추가합니다.
다중 줄 주석: =begin과 =end를 사용하여 여러 줄에 걸쳐 주석을 작성합니다.

용어 정리

용어	설명
한 줄 주석	`#` 뒤에 오는 내용으로, 코드의 한 줄을 설명합니다.
다중 줄 주석	`=begin`과 `=end` 사이에 있는 모든 내용을 주석으로 처리합니다.

3. 기본 코드 예제

# 한 줄 주석: 이 코드는 두 숫자의 합을 계산합니다.
def add(a, b)
  a + b # a와 b를 더합니다.
end

# 다중 줄 주석의 예
=begin
이 함수는 두 숫자의 합을 반환합니다.
매개변수 a와 b는 숫자여야 합니다.
=end
result = add(5, 3) # 5와 3을 더한 결과를 result에 저장합니다.
puts result # 결과를 출력합니다.

실행 결과: 8
코드 설명:

- # 한 줄 주석: 간단한 설명을 추가합니다. - def add(a, b): add라는 함수를 정의합니다. - a + b: 두 매개변수 a와 b를 더합니다. - =begin과 =end: 함수에 대한 설명을 다중 줄 주석으로 작성합니다. - result = add(5, 3): add 함수를 호출하여 5와 3을 더한 결과를 result에 저장합니다. - puts result: 최종 결과를 출력합니다.

4. 실전 활용 예제

쇼핑몰 장바구니 구현:

   # 장바구니에 상품을 추가하는 함수
   def add_to_cart(cart, item)
     cart << item # 장바구니에 상품을 추가합니다.
   end

   # 장바구니 초기화
   cart = []
   add_to_cart(cart, "사과") # 사과를 장바구니에 추가합니다.
   puts cart.inspect # 장바구니 내용을 출력합니다.

- 이 예제에서는 장바구니에 상품을 추가하는 기능을 구현하며, 주석을 통해 각 단계의 의도를 명확히 합니다.

사용자 입력 처리:

   # 사용자로부터 이름을 입력받는 함수
   def get_name
     print "이름을 입력하세요: " # 사용자에게 이름 입력 요청
     gets.chomp # 입력받은 이름을 반환합니다.
   end

   name = get_name # 사용자 이름을 변수에 저장합니다.
   puts "안녕하세요, #{name}님!" # 인사 메시지 출력

- 사용자 입력을 처리하는 과정에서 주석을 사용하여 각 단계의 목적을 설명합니다.

5. 흔한 실수와 주의사항

주석을 과도하게 작성하기:

- 잘못된 코드:

     # 이 코드는 숫자를 더합니다
     # a와 b를 더하고 결과를 반환합니다
     # 함수 이름은 add입니다
     def add(a, b)
       a + b
     end

- 올바른 코드:

     # 두 숫자의 합을 반환하는 함수
     def add(a, b)
       a + b
     end

- 주석은 필요한 만큼만 작성해야 하며, 코드가 명확하다면 불필요한 설명은 피해야 합니다.

주석과 코드의 불일치: