cour et des liens vers des classes / modules dans le doc

Question

Je change actuellement de rdoc à la cour pour mon logiciel rubis documentaion.

Dans mon doc je souvent référence à des classes / modules des commentaires, par exemple:

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

rdoc crée correctement un lien vers l'Mysoft :: :: Mypackage Utilitaire :: Logger page de documentation de classe, alors que la cour ne tient pas compte de la balise et considère le nom de la classe en tant que chaîne simple.

Je sais que la cour a l'étiquette @see, mais cela va créer une section distincte « Voir aussi » dans la documentation, alors que je dois faire référence à la classe / modules à l'intérieur de mon texte de description.

Il me manque sûrement quelque chose, mais si vous avez des exemples sur la façon dont cela doit être fait avec la cour, je vraiment apprécier.

Merci par advace,

dl

Answer 1

la documentation :

  

YARD une syntaxe spéciale pour relier à d'autres objets de code ou des fichiers. La syntaxe est {ObjectName#method OPTIONAL_TITLE}. Cette syntaxe est acceptable partout dans la documentation à l'exception de la balise @see, qui relie automatiquement ses données.

, vous voulez

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