RDoc: تغيير اسم "Atttributes:" الباب في ري التوثيق
-
11-07-2019 - |
سؤال
وأنا باستخدام بعض الفوقية البرمجة لتوليد مجموعة من الأساليب في روبي مثل ذلك:
class EmotionalObject
def self.mood( name, *details )
define_method(name) do
# ...
end
end
mood :happy, #...
mood :sad, #...
mood :ebuillent, #...
#...
end
وأنا أعلم أنني يمكن أن تمر rdoc
"المزاج -A" لحملها على الاعتراف مزاجي
كود جيل كما سمات، وهو مفيد، منذ ذلك الحين أنها على الأقل
الحصول على الاعتراف.
ومع ذلك، انهم حقا أكثر مثل الطرق العادية من الصفات، وذلك
أنا لا أريد منها مدرجة في إطار 'سمات: "الباب عندما أنظر
في وثائق باستخدام ri
. ليس لدي أية سمات العادية،
حتى لا يكون هناك أي طريقة بسيطة أستطيع أن مجرد تغيير عنوان هذا القسم ليكون "المزاج:"
أو شيء من هذا القبيل، بحيث يمكن للمستخدمين بلدي هي على الأقل الغريب بما فيه الكفاية لكتابة ri EmotionalObject#happy
.
المحلول
ولقد ضمني وفي قوالب RDoc، ولكن يمكنك جعل قالب جديد لاستخدامها من قبل تكرار الافتراضي "أتش تي أم أل" القالب وتغيير اسم العنوان باليد.
وانظر المصدر قالب RDoc هنا: <لأ href = "http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601" يختلط = "نوفولو noreferrer "> http://github.com/juretta/ruby/blob/master/lib/rdoc/generator/html/html.rb#L601 .
نصائح أخرى
ويبدو أن في مكان ما حول rdoc 2.4.1 أزالوا --accessor
والاستعاضة عن ذلك باستخدام تعليقات ##
على كل، طريقة ميتا. في حين أن هذا يسمح لك لاخراجهم من الباب الصفات، فإنه يفرض لك أيضا أن أعلق كل واحد على حدة.