2013-10-11 5 views
4

YARDoc을 사용하여 다음과 같은 방법으로 문서화하고 있습니다. dangerous 굵게입니다YARD 주문 생산 맞춤화

# Here is my method 
# @arg woop [Woop] *dangerous* this parameter is output to the screen 
def shoop(woop) 
    puts woop 
end 

이것은 HTML을 생성합니다. 이 출력을 구문 분석해야하므로 사용자 지정 HTML 태그가 필요합니다. 즉, 다음 코드 주석이 YARDoc으로 구문 분석 될 때 dangerous이라는 단어가 태그 대신 <div class="custom"></div> 태그로 둘러싸여 있기 때문에 Nokogiri로 구문 분석하는 것이 훨씬 쉬워 지도록하고 싶습니다. 현재 Nokogiri와 구문 분석이 불가능하다고 말하는 것은 아니지만 YARD 코드의 변경 사항에 조금 더 어색하고 취약합니다.

# Here is my method 
# @arg woop [Woop] **dangerous** this parameter is output to the screen 
def shoop(woop) 
    puts woop 
end 

내가 수행 할 수있는 기능이 YARD에 있습니까? 맞춤 템플릿을 만드는 방법을 살펴 보았습니다.하지만 코드 분석과 관련하여 더 많은 것으로 보입니다. 그런 다음 맞춤형 마크 다운 템플릿을 만드는 방법을 검사했지만이 방법을 수행 할 수 있는지 또는 수행해야 하는지를 알지 못했습니다. 나는 잘못된 나무를 짖고 내 방식으로 던진 Google 키워드에 감사한다는 인상을 받기 시작했습니다. 코드를 복제 할 필요없이 내가 이전 질문에서 설명했듯이
, 내가 인터페이스를 정의하기 위해 노력하고있어 :

이유는 처음에 HTML을 구문 분석하는 데 노력하고있어. 이 예제에서는 서버가 위험하지 않은 메서드와 다르게 위험한 메서드를 "호출"하도록합니다.

+0

왜 출력을 구문 분석해야하는지 더 설명 할 수 있습니까? 아마도 필요한 데이터가있는 사용자 지정 출력 형식을 만드는 몇 가지 방법이있을 수 있으므로 HTML 구문 분석을 피할 수 있습니다. – Shepmaster

+0

시도해 보았지만이 질문없이 코드 검토로 전환하는 방법에 대해 자세히 알지 못합니다. – Seanny123

답변

3

Markdown을 사용하면 인라인 HTML을 포함 할 수 있습니다. 그래서 아마 시도 :

# Here is my method 
# @arg woop [Woop] <div class="custom">dangerous</div> this .... 
def shoop... 
... 

을이 작동하는 경우, 당신은 다음 doc/css/common.css 파일의 기본 CSS를 오버라이드 (override) 할 수있다.

+0

나는 css 파일에 대해 몰랐다. 그래서 고마워.하지만 인라인 HTML이 없기 때문에 내 문서를 읽기가 더 어려워진다. – Seanny123

+0

그런 다음 다른 방법은 css 파일에서'.bold' 또는'.strong' 속성을 다시 정의하는 것입니다. 이렇게하면 정상적인 가격 인하를 사용할 수 있지만 '위험한'또는 '위험한 **'은 원하는대로 형식이 지정됩니다. – pandita

+0

물론 그것은'.'없이 '굵은 글씨'와 '강하게'입니다. – pandita