코드 주석

나중에 처리할 작업에 대한 주석

미래에 처리될 것으로 예상되는 코드에 주석을 추가할 때 기술적 부채 이슈를 만듭니다. 그런 다음 코드에 만든 주석에 대한 링크를 넣습니다. 이렇게 하면 다른 개발자들이 주석이 여전히 관련이 있는지 신속하게 확인하고 해당 주석을 해결하기 위해 무엇을 해야 하는지 알 수 있습니다.

예시: 

# 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 구문을 사용한 예시: 

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