/doc (خيارات المحول البرمجي# C)
الخيار /doc يسمح لك بوضع تعليقات وثائق في ملف XML.
/doc:file
الوسيطات
- file
ملف الإخراج لـ XML يتم تعبئته مع التعليقات في ملفات مصادر التعليمات البرمجية للتحويل البرمجي.
ملاحظات
في ملفات مصادر التعليمات البرمجية تعليقات الوثائق التي تسبق التالية يمكن معالجتها وإضافتها إلى ملف XML:
ملف مصدر التعليمات البرمجية الذي يحتوي على Main يخرج أولا إلى XML.
لاستخدام ملف .xml الذي تم إنشاؤه للاستخدام مع الميزة IntelliSense اجعل اسم الملف لملف .xml يكون هو نفسه كما التجميع الذي تريده أن يعتمد ثم تأكد من أن ملف .xml في نفس دليل التجميع. وبالتالي، عندما يتم الإشارة إلى التجميع في مشروع Visual Studio, يتم العثور كذلك على ملف .xml . راجع تزويد تعليقات التعليمات البرمجية لمزيد من المعلومات.
إلا إذا قمت بالتحويل البرمجي بـ /target:module ، file سوف يحتوي على العلامات <assembly></assembly> التي تحدد اسم الملف الذي يحتوي على ملف التجميع الظاهر للحصول على ملف الإخراج من التحويل البرمجي.
ملاحظة
يتم تطبيق الخيار /doc على كل ملفات الإدخال ; أو, إذا تم التعيين في "إعدادات المشروع" كافة الملفات في المشروع. لتعطيل التحذيرات المتعلقة بـتعليقات الوثائق لملف معين أو مقطع تعليمات برمجية استخدم #pragma warning .
راجع العلامات المستحسنة لـتعليقات الوثائق لطرق لإنشاء وثائق من تعليقات في التعليمات البرمجية.
لتعيين خيار المحول البرمجي هذا في بيئة تطوير Visual Studio
افتح صفحة خصائص للمشروع.
عدّل خاصية ملف وثائق XML .
للحصول على معلومات حول تعيين خيار المحول البرمجي هذا بشكل برمجي, راجع DocumentationFile.