코드 주석

후속 작업을 위한 주석

미래에 다루어질 것으로 예상되는 코드에 주석을 추가할 때는 기술 부채 문제를 생성하십시오.

그런 다음 생성한 코드 주석에 대한 링크를 삽입하십시오.

이렇게 하면 다른 개발자들이 주석이 여전히 관련성이 있는지, 해결하기 위해 무엇을 해야 하는지를 신속하게 확인할 수 있습니다.

예시:

# 코드 소유자 열이 rule_type으로 마이그레이션될 때까지 사용 중단된 범위입니다.
# 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