2011-04-22 4 views
39

YARD으로 문서화하고있는 작은 코드 라이브러리가 있습니다. 나는 yardoc 명령을 실행하면 저에게 말한다 :yardoc을 사용하여 문서화되지 않은 모듈/클래스/상수/메소드를 나열하려면 어떻게합니까?

Files:   40 
Modules:  14 ( 0 undocumented) 
Classes:  39 ( 0 undocumented) 
Constants:  21 ( 4 undocumented) 
Methods:  239 ( 31 undocumented) 
88.82% documented 

대신 문서화되지 않은 상수와 방법을 찾기 위해 내 모든 코드를 통해 넘어 가고, 나는 그것이 단순히 문서화되지 않은 항목을 나열합니다. 아무도 이것을하는 방법을 안다?

답변

42

--list-undoc 옵션을 사용하면 문서화되지 않은 모든 개체와 파일 위치를 구체적으로 나열 할 수 있습니다.

yard stats --list-undoc 

또는

yard --list-undoc 
+0

니스! 그 옵션은'--help' 출력에 나열되지 않았고, yardoc은''[warn] : Unrecognized/invalid 옵션 : --list-undoc' '이라고했지만 어쨌든 작동했습니다. 감사! –

+0

이것은 허용 된 대답이 아니어야합니다. @ 아셔가 더 정확합니다. – g33kz0r

+0

감사합니다. 답변을 업데이트했습니다. 그러나 제프, 원하는 경우 답변을 다시 수락하십시오. –

25

이뿐만 아니라 저를 혼동. --list-undoc 옵션은 실제로 stats 명령 아래에 정의됩니다. 또한 명령은 이 아닌 yard이며 yard doc의 줄임말입니다.

yard stats --list-undoc 
+1

아, 그 경고를 설명합니다. 알아 둘만한; 감사! –

+1

참고로 yardoc보다는 실제로 "yard stats --list-undoc"입니다. – Asher

관련 문제