لماذا هو ": النقر:" مطلوب بناء الجملة؟

Question

يبدو أن الكثير من المكتبات / الإضافات استخدم بناء الجملة هذا:

  def self.included(base) # :nodoc:
    base.extend ClassMethods
  end

لماذا هو :nodoc: الجزء اللازم؟

Answer 1

ليست ضرورية. إذا تم تطبيقها على فئة، فإنها تقمع فقط الوثائق (RDoc) لجميع الأساليب في ملحق الفصل. الموصوفة في البرمجة روبي على النحو التالي:

: ندوك: - لا تشمل هذا العنصر في الوثائق. بالنسبة للفصول والوحدات والوحدات، سيتم أيضا حذف الأساليب والأسماء المستعارة والثوابت، والسمات مباشرة داخل الفئة أو الوحدة النمطية المتأثرة من الوثائق. بشكل افتراضي، سيتم توثيق الوحدات والفئات في هذه الفئة أو الوحدة النمطية.

Answer 2

لا أعتقد أنه من الضروري. في الواقع، في رأيي، إنها واحدة من أكثر السمات عديمة الفائدة من RDoc.

في كثير من الأحيان رأيتها أثناء قراءة رمز Libarie وكان علي أن أسأل نفسي "لماذا؟". لا أرى أي سبب لاستخدام هذه الميزة. إذا كنت لا تريد أن يستخدم الأشخاص الأسلوب الخاص بك، فما عليك سوى جعله خاصا. إنها متاعب كبيرة عند قراءة وثائق ومعرفة طريقة استدعاء طريقة تم استبعادها من الوثائق.