باستخدام C # XML تعليق Cref سمة Cref مع بناء جملة Params

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

  •  11-09-2019
  •  | 
  •  

سؤال

في C #، أحاول استخدامu003Csee cref="blah"/> للإشارة إلى توقيع الأسلوب الذي يحتوي على الكلمة الأساسية Params. أعرف أن هذا يحول قائمة المعلمة إلى صفيف، لكن لا يمكنني حتى معرفة كيفية الرجوع إلى صفيف في سمة CHEF. أنا أجد شيئا في عمليات البحث وأي شخص أعرفه لديه أي فكرة أيضا. المترجم يختنق على الأقواس المربعة. لقد جربت جميع أنواع المجموعات المختلفة، باستخدام الأقواس المجعد، باستخدام فئة الصفيف، ولكن لا شيء يعمل. هل يعرف أحد هذا؟

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

المحلول

يحتوي ECMA 334 PDF القياسي، المرفق E على نظرة عامة لائقة تعليقات وثائق XML. يمكنك تنزيل المعيار في:

http://www.ecma-international.org/publications/standards/ecma-334.htm.

على وجه التحديد، ستحتاج إلى قسم E.3.1، بدءا من الصفحة 496.

محتوى مشابه هو أيضا في MSDN (على الرغم من أن MSDN يبدو أن الملاحة الرهيبة في هذا الموضوع، مما يجعل من الصعب العثور على الأقسام الأخرى):

http://msdn.microsoft.com/en-us/library/aa664787(VS.71).aspx.

ما يعادل E.3.1:

http://msdn.microsoft.com/en-us/library/aa664807(VS.71).aspx.

قد تجد أيضا وثائق أحادية مفيدة:

http://www.go-mono.com/docs/index.aspx؟tlink=29@man٪3amdoc(5)

Specfically، يغطي قسم "تنسيق CHEF" اتفاقيات سلسلة المعرف.

تحديث 2018/05/23.

عنوان URL الخاص ب PDF القياسية ECMA-334 أعلاه روابط أحدث إصدار من المعيار. في عام 2009، كانت تلك النسخة الرابعة من المعيار. ومع ذلك، اعتبارا من ديسمبر 2017، أصبحت الطبعة الخامسة الحالية، وقسم E.3.1 من الطبعة الرابعة أصبحت القسم D.4.2 في الطبعة الخامسة.

تتوفر الإصدارات السابقة من معيار ECMA-334 للتنزيل من الصفحة التالية: https://www.ecma-international.org/publications/standards/ecma-334-arch.htm.

نصائح أخرى

بحسب ال تنسيق سلسلة معرف B.3.1 يتم إحضار صفيف مع [أقواس مربعة] (مع اختياري lowerbound:size تحديد المواصفات) ولكن إذا كنت ترغب فقط في الرجوع إلى مجموعة من نوع معين (أو حتى صفيف كائن)، فلا يمكنك الكتابة فقط

<see cref="Object[]"/>

بدلا من ذلك، تحتاج إلى تحديد أنك تقوم بإجراء مرجع من النوع مع T: بادئة، مثل

<see cref="T:Object[]"/>

لا يبدو أن هذا ينطبق عند الرجوع إلى حل زائد محدد لطريقة، مثل

<seealso cref="String.Join(String, String[])"/>

يمكنك فقط ترك الكلمة الأساسية للمعلومات ووضعها في النوع مثل هذا:

/// <summary>
/// <see cref="Method(string[])"/>
/// </summary>
public static void Main()
{
    Method("String1", "String2");
}

public static void Method(params string[] values)
{
    foreach (string value in values)
    {
        Console.WriteLine(value);
    }
}
مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top