الفناء والروابط إلى الفصول/الوحدات النمطية في المستند

Question

أقوم حاليًا بالتبديل من RDOC إلى الفناء لتوثيق برنامج Ruby الخاص بي.

غالبًا ما أشير في مستندتي إلى بعض الفئات/الوحدات النمطية من التعليقات ، على سبيل المثال:

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

تقوم RDOC بإنشاء رابط إلى MySoft :: MyPackage :: Utility :: Logger Class ، بينما يتجاهل Yard العلامة ويعتبر اسم الفصل كسلسلة بسيطة.

أعلم أن Yard يحتوي على علامة seee ، ومع ذلك سيؤدي ذلك إلى إنشاء قسم منفصل "انظر أيضًا" في الوثائق ، بينما أحتاج إلى الرجوع إلى الفئة/الوحدات النمطية داخل نص الوصف الخاص بي.

من المؤكد أنني أفتقد شيئًا ما ، ولكن إذا كان لديك أي أمثلة على كيفية القيام بذلك مع الفناء ، فأنا أقدر حقًا.

شكرا لكل Advace ،

DL

Answer 1

Quoth وثائق:

يدعم Yard بناء جملة خاص لربط كائنات أو ملفات رمز أخرى. بناء الجملة {ObjectName#method OPTIONAL_TITLE}. هذا بناء الجملة مقبول في أي مكان في الوثائق باستثناء @see العلامة ، والتي تربط بياناتها تلقائيًا.

لذلك تريد

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