C # XML /// تعليقات، أين <إرجاع> علامة تظهر؟

Question

أنا حاليا طالب برمجة، ومن الواضح أن سؤالي بسيط، لكنني لم أتمكن من العثور على الإجابة عليه عبر الإنترنت. حتى هنا هو عليه:

في XML /// تعليقات في C #، أين <returns> علامة تظهر، وأنا أعلم أن كل شيء الوارد في <summary> تظهر العلامة في IntelliSense عند تحكيم الماوس فوق استدعاء الأسلوب الخاص بك، ولكن ليس علامة الإرجاع.

إذن أين <returns> علامة تأتي في؟

شكرا.

Answer 1

عندما ترى الطريقة في العرض >> مستعرض الكائنات

على سبيل المثال سوف ترى شيئا مثل هذا:

private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex)
    Member of MyAddIn.CommandHandlers.CommandHandler

Summary:
Returns the column index with specified name and in specified row

Parameters:
worksheet: Target worksheet
columnName: Column name to find
rowIndex: Row index in which to search the column
startColumnIndex: Start index of the column

Returns:
The index of column if found, else returns 0

Answer 2

إذا قمت بإنشاء وثائق API من التعليقات، فسوف تظهر في قيمة الإرجاع الجزء، كما رأينا هنا, ، قبل مباشرة ملاحظات الجزء.

Answer 3

عند اختيار إنشاء ملف توثيق XML على تجميع، يتم نسخ كل ما هو الوارد في تعليقات وثائق XML إلى هذا الملف. برامج مثل sandcastle. ثم يمكن بناء وثائق HTML أقرب إلى MSDN من ذلك.

لا تظهر في Intressisense Visual Studio الخاصة، بقدر ما أعرف. ولكن هذا ليس عذرا لعدم كتابة شيء هناك :-). إعادة بيع CTRL + Q على سبيل المثال هل اظهره.

Answer 4

الأقسام الأخرى (أساسا أي شيء استثناء summary) لن يظهر في Intellisense. يهدف فقط إلى الظهور في الوثائق التي تم إنشاؤها من XML، باستخدام أداة مثل sandcastle..