왜 ": nodoc :"구문이 필요한가?

StackOverflow https://stackoverflow.com/questions/1709630

  •  19-09-2019
  •  | 
  •  

문제

많은 라이브러리/플러그인 이이 구문을 사용하는 것 같습니다.

  def self.included(base) # :nodoc:
    base.extend ClassMethods
  end

왜 :nodoc: 부품이 필요합니까?

도움이 되었습니까?

해결책

필요하지 않습니다. 클래스에 적용되는 경우 클래스 확장의 모든 방법에 대한 문서 (RDOC) 만 억제합니다. Ruby 프로그래밍에 다음과 같이 설명했습니다.

: Nodoc : - 문서 에이 요소를 포함하지 마십시오. 클래스 및 모듈의 경우 영향을받는 클래스 또는 모듈 내에서 메소드, 별칭, 상수 및 속성도 문서에서 생략됩니다. 그러나 기본적으로 해당 클래스 또는 모듈 내의 모듈 및 클래스가 문서화됩니다.

다른 팁

나는 그것이 필요하다고 생각하지 않습니다. 사실, 제 생각에는 RDOC의 가장 쓸모없는 기능 중 하나입니다.

Libarie의 코드를 읽는 동안 나는 그것을 여러 번 보았고 나는 "왜?"라고 스스로에게 물어봐야했다. 이 기능을 사용해야 할 이유가 없습니다. 사람들이 당신의 방법을 사용하기를 원하지 않는다면, 개인을 비공개로 만드십시오. 문서를 읽고 문서에서 남은 메소드에 대한 메소드 호출을 볼 때 큰 번거 로움입니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top