내 클래스에서 RDoc 주석을 사용하여 작성한 일부 레이크 작업을 문서화하려고하며 대괄호를 나타내는 데 문제가 있습니다. 매개 변수를 사용하여 레이크 작업을 실행하는 방법에 대한 몇 가지 예를 추가하고 이렇게 rdoc 줄을 추가하고 싶습니다.RDoc에서 대괄호 ([])를 어떻게 표시합니까?
# 예 : rake build[MyProject]
문제는 RDoc 파서가 대괄호를 인쇄하는 대신 링크를 생성한다는 것입니다. 나는 모든 종류의 이스케이프 시퀀스를 시도했다 : [; [[; # {[MyProject]}; & # 91; MyProject & # 93; 하지만 아무것도 작동하는 것 같습니다.
대괄호를 이스케이프 처리하여 링크로 변환되지 않는 방법이 있습니까?
덕분에, 더 실험과 아론 잘
나는 그것을 할 수있는 방법을 발견했다. 각 줄 앞에 두 개의 공백을 넣으면 RDoc은이 줄을 미리 서식이 지정된 텍스트로 취급하고 대괄호를 렌더링합니다. 나를 위해 충분하다.
결과 RDoc 라인은 다음과 같습니다
# eg. rake build[MyProject]
때로는 해결책은 간단합니다.
text[par]과 같은 코드는 텍스트과 같은 링크를 만듭니다. 그러나 text과 [par] 사이에 공백을두면 파을 대괄호로 사용합니다.
[]와 다른 버전의 짧은 개요 :
* [par] labeled list
* x[par] x is linked with par
* x [par] Text as is (space between x and par)
* [] brackets disapear
* x _[par]_ Content between[] disapears.
당신이 기울임 꼴의 text<space>[par] -solution와 텍스트를 확인하려면, 당신은 <em>...</em> 변형 (안 밑줄 변형 _..._)를 사용해야합니다.
<tt> 태그는 링크 텍스트 [하이퍼 링크] 구문을 이스케이프하고 텍스트를 고정 폭 글꼴로 지정합니다.
예 :
그래서이 rdoc
# eg. <tt>rake build[MyProject]</tt>
은이 문서를 생성합니다. rake build[MyProject]
코딩 샘플을 보여주기 때문에 들여 쓰기가 정확합니다. 그것은 들여 쓰기되어야하고 고정 된 너비 글꼴로 표시되어야합니다. 이는 수용된 규칙이기 때문입니다. –
이 질문에 대한 대답을 수락하십시오. 그렇게하면 SO의 인터페이스에서 응답 한 것으로 표시됩니다. –