Ruby 코드를 문서화하는 방법은 무엇입니까?

Question

루비 코드를 문서화 할 때 특정 코드 규칙이 있습니까? 예를 들어 다음 코드 스 니펫이 있습니다.

require 'open3' 

module ProcessUtils 

    # Runs a subprocess and applies handlers for stdout and stderr 
    # Params: 
    # - command: command line string to be executed by the system 
    # - outhandler: proc object that takes a pipe object as first and only param (may be nil) 
    # - errhandler: proc object that takes a pipe object as first and only param (may be nil) 
    def execute_and_handle(command, outhandler, errhandler) 
    Open3.popen3(command) do |_, stdout, stderr| 
     if (outhandler) 
     outhandler.call(stdout) 
     end 
     if (errhandler) 
     errhandler.call(stderr) 
     end 
    end 
    end 
end 

이것은 괜찮 으면 좋겠지 만 우수한/우수한 문서화 방법이 있습니까?

Answer 1

RDoc 프로세서에 대한 문서를 대상으로해야합니다. RDoc 프로세서는 문서를 찾아 HTML을 생성 할 수 있습니다. 여러분은 여러분의 의견을 적절한 장소에 넣었으나, RDoc이 어떻게 형식화하는지 알 수있는 종류의 태그에 대해 배우려면 RDoc documentation을 봐야합니다. 다음과 같이이를 위해, 나는 당신의 코멘트를 다시 포맷 것 :

여기

# Runs a subprocess and applies handlers for stdout and stderr 
    # Params: 
    # +command+:: command line string to be executed by the system 
    # +outhandler+:: +Proc+ object that takes a pipe object as first and only param (may be nil) 
    # +errhandler+:: +Proc+ object that takes a pipe object as first and only param (may be nil) 

Answer 2

정식 버전은 RDoc입니다. 게시 한 버전과 매우 유사합니다.

링크를 샘플 섹션은 내가 매우RDoc을 사용하는 것이 좋습니다 것입니다 당신에게

Answer 3

을 보내 참조하십시오. 그것은 거의 표준입니다. 코드 주석을 읽기 쉽고 프로젝트에 대한 웹 기반 문서를 쉽게 작성할 수 있습니다.

Answer 4

레일에는 일부 API Documentation Guidelines이 있습니다. 아마 좋은 출발점 일 겁니다.

Answer 5

당신은 또한 루비 TomDoc 확인할 수 있습니다 ruby documentation system (RDOC)

Answer 6

에 대한 설명서입니다 - 버전 1.0.0-RC1을.

http://tomdoc.org/

Answer 7

내가 언급 한대로 RDoc을 알아가는 건의 할 것입니다. 그러나 매우 인기있는 YARD A Ruby Document 도구를 무시하지 마십시오. Ruby에서 온라인으로 볼 수있는 많은 문서는 Yard를 사용합니다. RVM은 Yard를 알고 있으며 사용 가능한 경우 Yard를 사용하여 컴퓨터에서 설명서를 생성합니다.

야드 (Yard)가 사용하는 것처럼 RDoc이 여전히 필요합니다.