상수 값과 관련된 문서를 적절한 방법으로 표시하고 표시하려면 어떻게합니까?

Question

Ruby on Rails 3.1.0을 사용하고 있으며 YARD 0.7.4를 사용하려고합니다.

: 나는 yardoc (또는 yard doc) 명령은 다음과 같다 실행 한 후

# [Fixnum] Test constant documentation. 
TEST_CONSTANT = 1 

하지만 HTML 출력 : 내 수업 시간에 내가이 상태 때문에, 상수 값을 기록하고 싶습니다 위의 이미지에서 HTML 문서가 잘 렌더링/생성되지 않았 음을 알 수 있습니다. YAML documentation을 읽었지만 여전히 문제가 있습니다 : 상수 값과 관련된 문서를 더 잘 보여주고 표시하는 방법은 무엇입니까?

Answer 1

나는 또한이 문제에 부딪 쳤고 Google은이 답글없는 게시물을 내게 넘겼습니다. 다른 포럼에서 Loren Segal (Yard 제작자)의 답변을 발견했습니다 : link_to_forum. 완전성을 이유로 동일한 문제를 겪는 사람들을 위해 다음을 추가합니다.

다른 모든 개체를 문서화하는 것과 같은 방식으로 문서화합니다. 그냥 상수 위에 주석을 넣으십시오.

# Documentation here 
TEST_CONSTANT = 1 

적어도 나에게는 결과 형식이 약간 이상하게 보입니다. 먼저 상수 이름을 형식화 한 다음 설명과 값을 표시합니다. 먼저 이름과 값이 뒤 따르는 설명을 기대합니다.