ruby代码和项目自述文件中的文档的最佳wiki语法

Question

是否有像rdoc,markdown等的wiki语法？在ruby世界中推荐？我有时会编写开源代码,并且没有粘合剂,我应该在Code文档和README文件中使用哪种语法.什么对我有用,为什么你使用它.

Answer 1

RDoc是默认的文档工具.RDoc语法是Ruby文件和库中允许的默认语法.

您可能会发现TextTile或Markdown在Ruby类之外用于文本文件,例如README或CHANGELOG文件.但这不是标准的sintax所以你需要一种方法告诉解析器文件的编写方式,通常这种方式是文件扩展名.

例如,GitHub正好遵循这一惯例.除非指定了.textile或.markdown扩展名,否则该文件将被解析为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 == Textile)

请记住:AFAIK,内联文档始终被解析为RDoc.