كيفية تحديد النوع في تعليق شمل <return> التعليق

Question

في بلدي ج # شمل التعليق <return> التعليق ، أود الإخراج (أنا باستخدام ساندكاسل) لتحديد النوع الذي يتم إرجاعه ، ولكن أنا غير قادر على معرفة كيفية القيام بذلك.

مثال بسويدو:

///<summary>
///Serves as a hash function for a particular type.
///</summary>
///<returns **Type="System.Int32"**>
///A hash code for the current Object.
///</returns>
public virtual int GetHashCode(){...}

المثال أعلاه هو وهمية من ما تخميني هو أن أقول ساندكاسل كيفية تحديد نوع العودة التي تم توثيقها في Syntax قسم من الوثائق-وليس ذلك.

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

هل لدينا لتحديد نوع يدويا ، أو يمكننا تحديد نوع (على غرار المثال وهمية) والسماح ساندكاسل تحديد كيفية عرض / تنسيق الإخراج-على غرار كيفية ساندكاسل يعرض تلقائيا / تنسيقات نوع للمعلمات عبر <param> الوسم.

Answer 1

هذا المنصب (يوليو 2011) لديه رد من إريك وودروف (مؤلف شفب) بشأن عدم وجود نوع العودة التي يتم عرضها داخل <return> الوسم:

القلعة الرملية لا تجعل المعلومات نوع للعودة المعلومات وأنا لا أعتقد أنه من أي وقت مضى.شريطة أن تكون المعلومات في ملف معلومات الانعكاس ، يمكن أن تكون تحويلات شسل تعديل لجعله.ليس لدي الوقت للنظر في الأمر الآن ولكن قد تكون قادرة على في مرحلة ما لمعرفة ما إذا كان ذلك ممكنا.

أفترض أن الإجابة الرسمية على عملي هي;ساندكاسل ليس لديها طريقة تلقائية لتحديد نوع العودة ولكن ، مثل السكيت ألمح بالفعل إلى ، فإنه أيار / مايو يكون من الممكن تحقيق ذلك عن طريق تعديل التحولات شسل.

Answer 2

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

وأظن انها مسألة التغيير والتبديل في نمط القلعة الرملية إذا كنت تريد حقا - ولكن هل تجد أنه من المفيد بشكل خاص?ليس الأمر كما لو أن المستخدمين لا يمكنهم النقر فقط على نوع الإرجاع في توقيع الطريقة.(على الأقل هذا ما يبدو أن هذا هو الحال بالنسبة لنمط النموذج الأولي في شفب.انظر ال وثائق وقت نودا للحصول على مثال على ما يبدو.)

في مسن ، ثم توقيع الطريقة لا لديك روابط (على الأقل ليس في كروم;أنا لا أعرف ما إذا كان مختلفا في إي) ولكن شخصيا أفضل أن يكون في التوقيع بدلا من ذلك من التبعثر حتى الوثائق الفعلية.