سؤال

لقد كنت أحاول توثيق جميع الأنواع والأساليب والخصائص وغيرها من مكتبة فئة باستخدام تعليقات XML ولكنها تعمل في تأثير فضولي ينطوي على cref السمة (المستخدمة من قبل see علامات على سبيل المثال). الذهاب من نصيحة صفحة MSDN هذه بالإضافة إلى اتباع أمثلة أخرى مختلفة على MSDN ومواقع الويب الأخرى، يبدو أنه عندما يحدد المرء قيمة مرجعية باستخدام cref العلامة، يجب أن تكون مسبقا مع علامة معينة صنف الركينة (مثل "T:" للنوع "و" M: "للطريقة).

ومع ذلك، فإن استخدام Microsoft Sandcastle، لاحظت أنه من خلال فقدان هذه البادئات هناك تأثير في الوثائق التي تم إنشاؤها (ملف تعليمات CHM في هذه الحالة). بما في ذلك البادئات (في جميع المواقف التي أصدق)، يتم تقديم المرجع على الصفحة كصوص جريئة ... ومع ذلك، فإن إلتصاق البادئة يتم تقديم المرجع كمركز (رابط) إلى صفحة التباين داخل مرجع API. يبدو الأمر غريبا جدا بالنسبة لي أن الطريقة الموصى بها للادئة (الكل؟) هي إعطاء أقل نتيجة مفيدة - لماذا يجب تقديم المرجع بأنه جريء في حالة واحدة ويرتبط في مكان آخر؟ سأكون ممتنا إذا كان شخص ما يمكن أن يلقي بعض الضوء على هذا.

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

المحلول

يبدو أن هذا كان علة في sandcastle.

ما هو إصدار Sandcastle الذي تستخدمه؟

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

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

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top