[ruby] 적절한 RDoc 구문에 대한 훌륭하고 견고한 참조가 있습니까?

Program / 글쓴이

적절한 RDoc 구문에 대한 훌륭하고 견고한 참조를 찾고 있습니다. 추천? 나는 명확하게 보여주는 것을 찾을 수없는 것 같다 :

  1. 클래스 메서드 및 매개 변수를 문서화하는 방법
  2. 클래스 또는 클래스 메서드의 기능을 문서화하는 방법.

답변

공식 rdoc 예제는 GitHub 소스 와 함께 여기 에서 찾을 수 있습니다 .

에서 문서 rdoc.rubyforge.org가 의 버전보다 더 완전한 것으로 보인다 rdoc.sourceforge.net (부수적으로 2003 년 수정 된 날짜가 있습니다).

또한 Ruby 코어 및 stdlib 문서와 같은 훌륭한 예제 소스가 있습니다. 예를 들어,에서 클래스 메소드 중 하나를 살펴 File클래스 :

File.atime (file_name) => 시간

명명 된 파일에 대한 마지막 액세스 시간을 Time 개체로 반환합니다.

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

첫 번째 줄을 클릭하여 RDoc 마크 업을 포함한 원본 소스 코드를 볼 수 있습니다 (이 답변에 포함 된 견적이 아닌 실제 RDoc 페이지에서). 이 경우 메서드는 C로 구현되었지만 RDoc 형식은 Ruby에서 구현 된 것과 동일합니다.

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *
 *  Returns the last access time for the named file as a Time object).
 *
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *
 */

여기에서 call-seq:메서드 이름과 매개 변수를 선택한 텍스트로 바꿀 수 있다는 것을 알 수 있으며 이는 클래스 메서드에 매우 유용합니다. 또한 Markdown과 유사하게 들여 쓰기하여 고정 폭 글꼴로 예제 코드를 표시하는 방법도 보여줍니다.

답변

RubyForge가 은퇴 한 이후 , 여기에 새로운 링크입니다 :

http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/RDoc/Markup.html

답변