[Fix] 최상위 클래스 문서 주석 Rubocop 누락

Rubocop은 레일 프로젝트에서 모범 사례를 적용하는 가장 좋은 방법입니다. rubocop이 활성화된 프로젝트에서 작업하는 동안 경고가 발생하는 것은 정상입니다. 최상위 클래스 문서 주석이 없습니다. [스타일/문서]. 이 경우 경고를 수정하거나 비활성화할 수 있는 세 가지 옵션이 있습니다.

경고

최상위 클래스 문서 주석이 누락되었습니다. [스타일/문서]

수정에 사용할 수 있는 옵션

다음 3가지 옵션 중 하나를 사용하여 이 경고를 비활성화하거나 수정할 수 있습니다.

프로젝트에서 경찰 비활성화

한 클래스에서만 경찰을 비활성화

클래스 선언 바로 위에 주석 추가

옵션 1: 프로젝트에서 경찰 비활성화

우리가 사용하는 대부분의 클래스는 자체 설명입니다. 즉, 개발자로서 클래스가 수행하는 작업을 쉽게 이해할 수 있습니다. 일반적으로 이 규칙은 그다지 유용하지 않기 때문에 대부분의 경우 전체 프로젝트에서 이 규칙을 비활성화합니다. 프로젝트 전체에서 비활성화하려면 구성 파일에 다음 경찰을 추가하십시오.

# .rubocop.yml

Style/Documentation:
  Enabled: false

옵션 2: 한 클래스에서만 경찰 비활성화

이 경찰이 프로젝트에서 중요하다고 생각하고 구성 파일에서 비활성화하고 싶지 않다면 필요에 따라 한 클래스에서만 비활성화할 수 있습니다.

# app/models/user.rb

# rubocop:disable Style/Documentation
class User
end

옵션 3: 클래스 선언 바로 위에 주석 추가

경고가 제안하는 대로 주석을 추가하여 경고를 사라지게 할 수도 있습니다.

# app/models/user.rb

# Service to download ftp files from the server
class FtpService
end

이 문서는 누락된 최상위 클래스 문서 주석을 해결하기 위한 것입니다. [스타일/문서], 이 수정 사항은 rubocop이 던지는 다른 모든 경고에도 적용됩니다. 사용 중인 옵션을 놓쳤습니까? 아래 의견에 알려주십시오.

이미지 크레딧: Matt Popovich의 Unsplash 표지 이미지