RDoc

RDoc
원저작자	데이브 토머스
안정된 릴리스	5.1.0 / 2017년 2월 24일, 5년전(
저장소	github.com/ruby/rdoc ;
기입처	루비
운영 체제	크로스 플랫폼
유형	임베디드 문서 생성기
면허증.	GPLv2
웹 사이트	ruby.github.io/rdoc/

Dave Thomas가 설계한 RDoc은 Ruby 프로그래밍 언어용 임베디드 문서 생성기입니다.Ruby 소스 코드를 분석하여 Ruby 오브젝트 및 메서드에 대한 페이지의 구조화된 컬렉션을 생성합니다.코드 코멘트는 자연스러운 스타일로 추가할 수 있습니다.RDoc은 Ruby 코어 배포의 일부로 포함되어 있습니다.RDoc 소프트웨어와 포맷은 Ruby Document 포맷(관련 소프트웨어 RD 포함)의 후속 버전입니다.

RDoc은 클래스, 모듈 및 메서드를 구문 분석하여 생성된 API 파일에 나열하기 때문에 대상 소스 코드에 명시적인 주석이 포함되어 있지 않은 경우에도 사용 가능한 문서를 생성할 수 있습니다.RDoc은 또한 Ruby Ri 데이터 파일을 생성하기 위한 엔진을 제공하여 명령줄에서 API 정보에 대한 액세스를 제공합니다.

RDoc과 Ri는 현재 Eric Hodel과 Ryan Davis가 관리하고 있습니다.

구문

RDoc은 RDoc Markup, Markdown, tomdoc 및 rdtool의 4가지 마크업 언어를 지원합니다.자체 RDoc Markup이 기본적으로 사용됩니다.RDoc Markup에서 특수 지시문은 콜론 쌍으로 둘러싸여 있습니다.예를 들어 메서드가 다음과 같은 인수를 사용함을 나타냅니다.site그리고.article글씨를 쓸 수 있다:args: site, article를 클릭합니다.^[1]