توثيق باستخدام Sandcastle: الرجوع إلى قيمة التعداد باستخدام

Question

أنا أستخدم Sandcastle 2.4.10520 و Sandcastle Help File Builder 1.8.0 لإنشاء ملف تعليمات .chm.

في وثائق بلدي ، أنا أستخدم <see> العلامات.

إذا حاولت إحالة التعداد مثل <see cref="NumberStyles"/> إنه يعمل بشكل مثالي.

إذا حاولت إحالة قيمة التعداد مثل <see cref="NumberStyles.AllowTrailingWhite"/> أحصل على رابط في ملف الوثائق ، لكن الرابط يقودني إلى صفحة MSDN لم يتم العثور عليها

لا أحصل على أي تحذيرات - وثائق XML صحيحة.

لقد لاحظت أن صفحات MSDN التي تشير إلى قيمة التعداد تحتوي أيضًا على رابط لم يتم العثور على صفحة. فمثلا: طريقة uint64.parse (سلسلة ، أرقام ، iformatprovider) يعود الى NumberStyles.AllowHexSpecifier وهذا يؤدي إلى آخر صفحة MSDN لم يتم العثور عليها.

هل يجب أن أشير إلى التعداد بدلاً من قيمة التعداد؟

ماذا علي أن أفعل لإحالة التعداد؟ هل هذا ممكن؟

Answer 1

حقيقة أنه يحدث على MSDN لا تبشر بشكل جيد. هل تحتوي قيم التعداد على وثائق XML؟

إذا كنت أتذكر بشكل صحيح ، فيجب أن تكون هناك إعدادات في SHFB تتيح لك إجبار توليد الوثائق للأعضاء الذين لا يملكون XML - أو ربما يكون إعدادًا يتيح لك استبعاد الأعضاء الذين لا يملكون XML Doc. بغض النظر ، امنح الإعدادات جيدًا مرة واحدة للتأكد من أنك لا تستبعد أعضاء التعداد بهذه الطريقة.

خلاف ذلك ، يجب أن تنشئ وثائق لكل عضو ، وقيم التعداد هي أعضاء من الأنواع مثل const أو الحقل الثابت.

تعديل: يبدو أنه على الأقل على موقع MSDN الأحدث ، لا يتم إعطاء قيم التعداد الفردي صفحتها الخاصة. على سبيل المثال ، ألق نظرة على أرقام التعداد. في هذه الحالة ، قد لا يكون لديك خيار أفضل من مجرد ربط التعداد.