ruby - objetos - Patio y enlaces a clases/módulos en el doc.

modulo ruby

Question

Actualmente estoy cambiando de rdoc a yard para mi documentación de Ruby Software.

En mi documento a menudo hago referencia a algunas clases / módulos de los comentarios, por ejemplo:

## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##

Rdoc crea correctamente un enlace a la página de documentación de la clase Mysoft :: Mypackage :: Utility :: Logger, mientras que yard ignora la etiqueta y considera el nombre de la clase como una cadena simple.

Sé que el patio tiene la etiqueta @see, sin embargo, esto creará una sección "Ver también" separada en la documentación, mientras que necesito hacer referencia a la clase / módulos con el texto de mi descripción.

Seguramente me estoy perdiendo algo, pero si tiene algún ejemplo sobre cómo debería hacerse esto con el patio, realmente lo apreciaría.

Gracias por anticipado,

dl

Answer 1

Quoth la documentación :

YARD admite una sintaxis especial para vincular a otros objetos de código o archivos. La sintaxis es {ObjectName#method OPTIONAL_TITLE} . Esta sintaxis es aceptable en cualquier parte de la documentación, con la excepción de la etiqueta @see , que enlaza automáticamente sus datos.

Entonces quieres

## == Provides various utility features
##
## == Features
##
## Logging: logging is provided by the {Mysoft::Mypackage::Utility::Logger} class
##