코드 주석

추후 조치를 위한 주석

미래에 처리될 것으로 예상되는 코드에 주석을 추가할 때 기술적 부채 이슈를 생성하세요. 그런 다음, 코드에 생성한 주석에 대한 링크를 넣어주세요. 이렇게 함으로써 다른 개발자들은 주석이 여전히 관련이 있는지 빠르게 확인할 수 있고, 이를 해결하기 위해 무엇을 해야 하는지 알 수 있습니다.

예시: 

# Deprecated scope until code_owner column has been migrated to rule_type.
# To be removed with https://gitlab.com/gitlab-org/gitlab/-/issues/11834.
scope :code_owner, -> { where(code_owner: true).or(where(rule_type: :code_owner)) }

클래스 및 메소드 설명

메소드 인수나 반환 값을 문서화할 때 YARD 구문을 사용하세요.

YARD 구문을 사용하지 않은 예시: 

class Order
  # 사용자의 이메일 주소로 연관된 주문 ID를 찾습니다.
  def order_ids_by_email(email)
    # ...
  end
end

YARD 구문을 사용한 예시:

```ruby class Order # 사용자의 이메일 주소로 연관된 주문 ID를 찾습니다. # # @param email [String, Array] 사용자의 이메일 주소 # @return [Array] def order_ids_by_email(email) # ... end end