Mejor sintaxis wiki para la documentación en el código de rubí y archivos README del proyecto

Question

¿Hay alguna sintaxis wiki como rdoc, reducción del precio, ... se recomienda en el mundo de rubí? Me escribir código fuente veces abierta y no tienen cola que la sintaxis que debe utilizar en los documentos de código y en los archivos README. Lo que sea útil para mí el que y por qué se utiliza.

Answer 1

RDoc es el instrumento de documentación por defecto. La sintaxis RDoc es el que viene por defecto permitido dentro de los archivos y bibliotecas de Ruby.

Usted puede encontrar texttile o utilizados fuera de rebajas clases de Ruby para archivos de texto, como el README o los archivos de Cambios. Pero esta no es la sintaxis estándar, de modo que se necesita una manera de contar el analizador de sintaxis, que el archivo se escribe con, por lo general esta manera es la extensión de archivo.

GitHub, por ejemplo, sigue exactamente este convenction. A menos que se especifique una extensión .textile o .markdown, el archivo se analiza como RDoc.

• http://github.com/weppos/whois (.rdoc == RDOC)
• http://github.com/rails/rails/tree/master/ railties / (sin extensión == RDOC, pero no para GitHub)
• http://github.com/technoweenie/restful-authentication /blob/master/README.textile (.textile == Textiles)

Recuerde: Que yo sepa, la documentación en línea siempre se analiza como RDoc

.

Answer 2

En Github, las personas utilizan sobre todo rdoc o textiles como formato para sus archivos readme. Rdoc también es muy útil para API-documentar su código, ya que la sintaxis se integra muy agradable en el código y es agradable de leer.