루비 코드 및 프로젝트 readme 파일의 문서화를위한 최고의 위키 신문

Question

Rdoc, Markdown과 같은 Wiki 구문이 있습니까? 때때로 오픈 소스 코드를 작성하고 코드 문서와 readme 파일에 사용해야 할 구문이 없습니다. 나에게 어떤 도움이되는지, 당신이 그것을 사용하는 이유.

Answer 1

RDOC는 기본 문서 도구입니다. RDOC 구문은 Ruby 파일 및 라이브러리 내부에서 허용되는 기본값입니다.

readme 또는 changelog 파일과 같은 텍스트 파일에 Ruby 클래스 외부에서 사용되는 Texttile 또는 Markdown을 찾을 수 있습니다. 그러나 이것은 표준 sintax가 아니므로 파일이 작성된 구문을 구문자에게 알리는 방법이 필요합니다. 일반적으로 이러한 방식으로 파일 확장자입니다.

예를 들어, Github는 정확히이 도입을 따릅니다. .textile 또는 .MARDDOWN EXTENSION이 지정되지 않는 한 파일은 RDOC로 구문 분석됩니다.

• http://github.com/weppos/whois (.rdoc == rdoc)
• http://github.com/rails/rails/tree/master/railties/ (확장 없음 == rdoc이지만 Github의 경우는 아닙니다)
• http://github.com/technoweenie/restful-authentication/blob/master/readme.textile (.textile == 섬유)

기억하십시오 : Afaik, 인라인 문서는 항상 RDOC로 구문 분석됩니다.

Answer 2

Github에서 사람들은 대부분 RDOC 또는 직물을 ReadMe-Files의 형식으로 사용합니다. RDOC는 또한 구문이 코드에 정말 멋지고 읽기가 즐겁기 때문에 코드를 API 문서화하는 데 매우 유용합니다.