ruby - ¿Es normal que YARD no reemplace el `código` con el código<code></code>?

markup rdoc

Question

Estoy empezando a usar YARD para documentar mi aplicación Rails. No especifiqué ningún controlador de marcado específico, pero habría esperado que el ''código'' se convirtiera en code , lo que no parece ocurrir. ¿Es este el comportamiento normal? ¿Tengo que agregar alguna opción adicional para que esto funcione? Gracias.

Answer 1

Desde GitHub, estaba acostumbrado a usar backticks para comentarios de código en línea. Entonces, después de algunas investigaciones, encontré la siguiente, muy buena solución.

• Añade la gema redcarpet a tu Gemfile
• Ejecutar comando de bundle
• Agregue --markup=markdown a su archivo .yardopts
• Iniciar el servidor YARD utilizando el yard server --reload
• Abra localhost: 8808 en su navegador

Ahora puedes usar la sintaxis como en GitHub, por ejemplo

```ruby
def bla; puts ''bla''; end
```

O

`this is inline code`

¡Bonito! :)

Answer 2

La sintaxis es un poco diferente de markdown (markdown vs rdoc), supongo. Usando ''+'' funciona. + código + se procesa en un bloque <code> .

Answer 3

Sin reducción, YARD mostrará un bloque de código para una línea con sangría, por ejemplo

  # This is a useful POSIX regex:
  #   [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}

Dos espacios de sangría parecen ser suficientes.