如何用Wiki语法优化ruby代码及项目自述文件的文档？

本文共计298个文字，预计阅读时间需要2分钟。

是的，存在RDoc和Markdown等Wiki语法。在Ruby世界中，RDoc是推荐使用的文档格式。如果你会编写开源代码，并且没有特定的粘贴要求，你应在Code文档和README文件中使用RDoc语法。

RDoc对我有用，因为它：- 是Ruby语言的官方文档格式。- 提供了丰富的标记和语法，便于生成格式化的文档。- 与Ruby的语法紧密集成，易于编写和维护。

你使用RDoc的原因可能包括：- 它是Ruby社区广泛接受的文档标准。- 它可以帮助其他开发者理解你的代码。- 它可以自动生成文档，节省时间和精力。

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

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

例如,GitHub正好遵循这一惯例.除非指定了.textile或.markdown扩展名,否则该文件将被解析为RDoc.

> github.com/weppos/whois(.rdoc == Rdoc)
> github.com/rails/rails/tree/master/railties/(无扩展== Rdoc,但不适用于GitHub)
> github.com/technoweenie/restful-authentication/blob/master/README.textile(.textile == Textile)

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