YARD 및 RDoc 호환성

YARD를 사용하여 코드를 문서화하고 예 : @overload 태그가 있고 다른 누군가가 내 보석을 설치하고 RDoc이 포함 된 설명서를 생성하므로 결과가 지저분하지 않습니까?YARD 및 RDoc 호환성

이 문제를 해결할 수있는 좋은 방법이 있습니까?

2012-02-21 mydoghasworms

일방 통행이 가능하지 않습니까? 즉, YARD는 RDoc을 읽을 수 있지만 다른 방법은 사용할 수 없습니다. 그리고 대부분의 사람들은 RDOC보다 YARD를 선호합니다. – sawa

네, 그게 제가 얻는 것입니다. 그러나 사람들이 여전히 RDoc을 사용하고 야드를 가지고 있지 않은 것처럼 보일 때, YARD 고유의 태그를 사용하여 코드를 문서화 할 때 어떻게 수용 할 수 있습니까? – mydoghasworms

is는 @overload을 지원하지 않지만 TomDoc은 유용 할 수 있습니다. RDoc은 이제 TomDoc을 즉시 사용할 수 있도록 지원하고 Yard는 yard-tomdoc 플러그인을 사용합니다. YARD는 대형 프로젝트의 경우 여전히 더 나은 (IMO) 편이지만 작은 라이브러리 나 도구의 경우 TomDoc은 잘 작동하며 두 시스템에서 모두 사용할 수 있습니다.

출처

2013-01-28 09:32:01 trans

YARD 및 RDoc 호환성

답변

관련 문제