2009-11-10 5 views

답변

20

필요하지 않습니다. 클래스에 적용되면 클래스 확장의 모든 메서드에 대한 문서 (rdoc)가 표시되지 않습니다.

:로 프로그래밍 루비에 설명 nodoc : - 가 문서에서이 요소를 포함하지 마십시오. 클래스 및 모듈의 경우 상수 및 메서드, 별칭 및 영향을받는 클래스 또는 모듈 내의 모듈에 직접있는 특성은 설명서에서 생략됩니다. 하지만 기본적으로 모듈과 클래스 또는 모듈 내의 클래스가 문서화됩니다.

2

필자는 그렇게 생각하지 않습니다. 사실, 제 생각에 그것은 RDoc의 가장 쓸모없는 기능 중 하나입니다.

libarie의 코드를 읽는 동안 여러 번 본 적이 있는데 "왜?"라고 물어 보았습니다. 이 기능을 사용할 이유가 없습니다. 사람들이 당신의 방법을 사용하기를 원하지 않는다면, 그것을 비공개로 만드십시오. 문서를 읽고 문서에서 제외 된 메소드에 대한 메소드 호출을 볼 때 큰 번거 로움이 있습니다.

+1

거기에 요점이 있습니다. 나는': nodoc :'이 결코 유용 할 수 없다는 것에 동의하지 않는다. 하지만 과도하게 사용되거나, 사람들이 어떻게 든 중요하지 않다고 생각하는 방법으로 사용하거나, 작성해야 할 것에 대해 생각할 수 없을 때 문서 작성을 피하는 방법으로 사용하는 경향이 있습니다. –

+0

아이러니하게도 "중요하지 않은"방법은 대개 내가 "왜 그렇게합니까?"라고 생각하는 것에 대해 내 머리를 긁적니다. 그': nodoc :'은 코드 (문서?) 냄새입니다 ... –

관련 문제