كيف يمكنني تمثيل قوسين مربع ([]) في RDOC؟

StackOverflow https://stackoverflow.com/questions/4214726

  •  26-09-2019
  •  | 
  •  

سؤال

أحاول توثيق بعض مهام RAKE التي كتبتها باستخدام تعليقات RDOC في صفي وأواجه مشكلة في تمثيل قوسين مربعة. أرغب في إضافة بعض الأمثلة حول كيفية تشغيل مهام Rake الخاصة بي مع المعلمات وبالتالي لدي خط RDOC مثل ذلك:

# على سبيل المثال. rake build[MyProject]

المشكلة هي أن محلل RDOC يتحول ينشئ رابطًا بدلاً من طباعة الأقواس المربعة. لقد جربت كل أنواع تسلسل الهروب: [؛ [[؛ #{[مشروعي]} ؛ [MyProject] ولكن لا شيء يبدو أنه يعمل.

هل هناك أي طريقة للهروب من هذه الأقواس المربعة حتى لا تتحول إلى رابط؟

شكرا ، هارون

هل كانت مفيدة؟

المحلول

حسنًا مع مزيد من التجارب ، اكتشفت طريقة للقيام بذلك. إذا وضعت مساحتين أمام كل سطر ، فإن RDOC يعامل الخط كنص منسق مسبقًا ويجعل الأقواس. هذا يكفيني.

خط RDOC الناتج هو:

#  eg. rake build[MyProject]

نصائح أخرى

ال <tt> سوف يهرب TAG من بناء جملة النص [Hyperlink] (وأيضًا وضع النص بخط Monospace).

لذلك هذا rdoc

# eg. <tt>rake build[MyProject]</tt>

سوف تنتج هذه الوثائق:

على سبيل المثال. rake build[MyProject]

في بعض الأحيان يكون الحل سهلًا.

رمز مثل text[par] يخلق نص مع رابط إلى قدم المساواة. ولكن إذا وضعت مساحة بين text و [par] لقد حصلت قدم المساواة مع أقواس مربعة.

نظرة عامة قصيرة على الإصدارات المختلفة مع []:

* [par] labeled list
* x[par] x is linked with par
* x [par] Text as is (space between x and par)
* []  brackets disapear
* x _[par]_  Content between[] disapears.

إذا كنت تريد صنع النص مع text<space>[par]-الحل بشكل مائل ، يجب عليك استخدام <em>...</em> البديل (وليس البديل السفلي _..._).

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top