هذا هو الأمر mdassembler الذي يمكن تشغيله في مزود الاستضافة المجانية OnWorks باستخدام إحدى محطات العمل المجانية المتعددة على الإنترنت مثل Ubuntu Online أو Fedora Online أو محاكي Windows عبر الإنترنت أو محاكي MAC OS عبر الإنترنت
برنامج:
اسم
؛ mdassembler - ترجمة الوثائق لاستخدامها في متصفح monodoc
موجز
com.mdassembler خيارات * DIRS +
الوصف
com.mdassembler قد عفا عليها الزمن من قبل mdoc(1). انظر تجميع mdoc(1) صفحة الدليل.
com.mdassembler هو برنامج يخلق .شجرة و الرمز البريدي ملفات للاستخدام في monodoc
متصفح الوثائق.
ال .شجرة و الرمز البريدي يتم نسخ الملفات في monodoc's تقارير عن مصادر العطور بدون العلبة الدليل ، والإقامة مع ملف
.مصدر الملف الذي يستخدمه monodoc لتحديد مكان الوثائق
عرض. ال .مصدر الملف / monodoc / source / @ basefile تحدد السمة اسم الملف
بادئة لملفات التوثيق. يجب أن يكون هذا هو نفس البادئة المستخدمة مع --خارج
المعلمة.
OPTIONS
--ECMA تم العثور على الوثائق داخل ديرس في تنسيق وثائق Mono ECMA. يرى
القادم بالأبيض والأسود ECMA توثيق شكل القسم أدناه.
--مسمك
تم العثور على الوثائق داخل ديرس موجود في وثائق مواصفات ECMA
شكل. انظر بالأبيض والأسود ECMA المواصفات الخاصه توثيق شكل القسم أدناه.
--خطأ
تم العثور على الوثائق داخل ديرس في شكل "خطأ". انظر خطأ
توثيق شكل القسم أدناه.
--مساعدة إظهار معلومات حجة البرنامج.
--رجل تم العثور على الوثائق داخل ديرس في شكل صفحة دليل. انظر رجل صفحة
توثيق شكل القسم أدناه.
-o ، --خارج اختصار
حدد بادئة ملف الإخراج. com.mdassembler ينشئ الملفات PREFIX.zip و
PREFIX.tree .
--بسيط
تم العثور على الوثائق داخل ديرس بتنسيق "بسيط". انظر الاشارات
توثيق شكل القسم أدناه.
--xhtml ، - hb
تم العثور على الوثائق داخل ديرس بتنسيق XHTML. انظر XHTML
توثيق شكل القسم أدناه.
صيغ
يتم دعم تنسيقات الوثائق التالية:
بالأبيض والأسود ECMA توثيق شكل
تنسيق توثيق XML مع ملف واحد لكل نوع.
شاهد mdoc(5) صفحة دليل لمزيد من المعلومات.
بالأبيض والأسود ECMA المواصفات الخاصه توثيق شكل
هذا ليس التنسيق الذي تبحث عنه.
هذا هو التنسيق المستخدم لتمثيل معيار ECMA-334 (C #) بداخله monodoc. ليس
تستخدم لعرض وثائق مكتبة الفصل ؛ لتوثيق مكتبة الفصل ، استخدم
--ECMA تنسيق.
خطأ توثيق شكل
يستخدم لتقديم رسائل خطأ مفصلة ، ويستخدم في monodocخطأ مترجم C #
مرجع "شجرة. ديرس ليس دليلاً ، ولكنه بدلاً من ذلك ملف تكوين يحتوي على
XML:
../../mcs/errors
cs ؟؟؟؟ *. cs
2
4
علوم الكمبيوتر {0: 0 ###}
/ ErrorProviderConfig / FilesPath يحدد مكان البحث عن الملفات ،
/ ErrorProviderConfig / Match يحدد نمط اسم الملف الذي سيتم البحث عنه بداخله
/ ErrorProviderConfig / FilesPath, / ErrorProviderConfig / ErrorNumSubstringStart و
/ ErrorProviderConfig / ErrorNumSubstringLength التحكم في أي جزء من اسم الملف يتم استخدامه
كرقم الخطأ ، و / ErrorProviderConfig / FriendlyFormatString يتحكم في كيفية عمل ملفات
تنسيق / عرض العقدة في ملف monodoc شجرة.
لكل ملف يتم العثور عليه ، يتم تحويله إلى HTML مع تطبيق تلوين بناء الجملة C #.
الاشارات توثيق شكل
يحول الملفات النصية إلى HTML عن طريق ترجمة كل سطر جديد إلى HTML جزء.
رجل صفحة توثيق شكل
يحول صفحات الرجل إلى HTML للعرض.
XHTML توثيق شكل
ينسخ ملف XHTML كما هو.
أمثلة
لتثبيت وثائقك للاستخدام مع monodoc:
إنشاء a PREFIX.source ملف
مع المحتويات:
حيث FORMAT هو تنسيق الوثائق المضمن في PREFIX.tree ملف،
على سبيل المثال ecma أو بسيط. اختصار is القادم basename of القادم .شجرة و الرمز البريدي الملفات التي
com.mdassembler يخلق. PATH هو "المسار" في شجرة monodoc التي يجب أن تحتوي
وثائق. انظر @ بادئة @ / lib / monodoc / monodoc.xml ملف للحصول على قائمة
قيم المسار ( //اسم العقدة القيم).
شاهد أيضاً: http://www.mono-
project.com/docs/tools+libraries/tools/monodoc/geneating-documentation/
إنشاء لك توثيق
انظر أيضا مونودوسير(1) صفحة الدليل ، على سبيل المثال
monodocer -assembly: foo.dll - المسار: foo / en
جمعيه القادم توثيق
mdassembler --ecma foo / en PREFIX
تأكد من أنك تستخدم نفس الشيء اختصار هنا كما فعلت أعلاه.
تثبيت القادم توثيق by استخدام القادم أمر
cp PREFIX.source PREFIX.tree PREFIX.zip \
`pkg-config monodoc --variable = sourcesdir`
(لاحظ backticks المستخدمة في ملف pkg-config الأمر!) هذا ينسخ ملف .مصدر ,
.شجرة و الرمز البريدي الملفات في monodoc تقارير عن مصادر العطور بدون العلبة الدليل ، والذي سيسمح monodoc
لعرض الوثائق.
استخدم mdassembler عبر الإنترنت باستخدام خدمات onworks.net
