mdoc - عبر الإنترنت في السحابة

برنامج:

اسم

mdoc - أداة إدارة التوثيق الأحادية

موجز

mdoc أمر [الخيارات] [وسائط]

نبذة عامة

mdoc هو نظام إدارة توثيق قائم على التجميع.

mdoc يسمح بإنشاء وتحديث الوثائق بذرة بناءً على محتويات ملف
حَشد. لا تعتمد على الوثائق الموجودة في شفرة المصدر.

الإيجابيات:

* رمز مقروئية. كثيرا ما يكون التوثيق الجيد (أ) مطولا ، و (ب) معبأ
مع الأمثلة. (للمقارنة ، قارن وثائق Microsoft .NET Framework ،
والتي غالبًا ما تكون صفحة أو أكثر من المستندات لكل عضو ، إلى وثائق JavaDoc ،
والتي يمكن أن تكون في الغالب جملة لكل عضو.)

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

* الموقع. تنسيقات التوثيق في المصدر (مثل ديوان الخدمة المدنية / دوك) ليس لديهم دعم
للعديد من اللغات البشرية. إذا كنت بحاجة إلى دعم أكثر من لغة بشرية
لأغراض التوثيق ، mdoc مفيد لأنه يسمح بإخراج كل لغة
الموجودة في الدليل الخاص بها ، و mdoc يمكن إضافة أنواع / أعضاء لكل منفصل
دليل التوثيق.

* الادارة. ليس من غير المعتاد أن يكون لديك وثائق منفصلة وتطوير
فرق. من الممكن أيضًا أن يتمتع فريق التوثيق بخبرة قليلة
مع لغة البرمجة المستخدمة. في مثل هذه الظروف ، مضمنة
التوثيق غير مرغوب فيه حيث قد يقوم فريق التوثيق بإدراجها دون قصد
خطأ في التعليمات البرمجية المصدر أثناء تحديث الوثائق. بدلا من ذلك ، أنت
قد لا ترغب في أن يتمكن فريق التوثيق من الوصول إلى الكود المصدري للأمان
الأسباب. mdoc يسمح بالاحتفاظ بالوثائق تماما منفصلة ومتميزة
من التعليمات البرمجية المصدر المستخدمة لإنشاء التجميع.

يمكن إنشاء الوثائق باستخدام mdoc تحديث أمر:

تحديث mdoc -o docs / en ProjectName.dll

بمجرد إنشاء بذرة التوثيق (ونأمل أن يتم ملؤها لاحقًا بـ
التوثيق الفعلي) ، هناك ثلاث طرق لعرض الوثائق:

* لإنشاء دليل بسيط لصفحات HTML (ملف HTML واحد لكل نوع) ، استخدم mdoc
تصدير- html:

mdoc export-html -o / srv / www / htdocs / ProjectName docs / en

* لاستخدام تطبيق ويب ASP.NET لعرض المصادر ، راجع: http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

من monodoc الخروج من المصدر ، يمكنك القيام بذلك:

محرك القرص المضغوط
صنع الويب

هذا سوف يستخدم XSP(1) لخدمة تطبيق ويب ASP.NET ؛ يزور http://localhost: 8080 / إلى
عرض الوثائق.

* لاستخدام ال monodoc(1) متصفح الوثائق ، يجب عليك أولا تجمع هيه
توثيق:

تجميع mdoc -o مستندات ProjectName / en

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



<موفر المصدر = "ecma" basefile = "اسم المشروع"
المسار = "مختلف" />


يوضح ملف التكوين أعلاه أن الوثائق بتنسيق ECMA ،
أن اسم الملف الأساسي هو اسم المشروع وأنه ينبغي توصيله في
"متنوع" جزء من شجرة التوثيق. إذا كنت تريد إلقاء نظرة على العقد المختلفة
المحددة في الوثائق ، يمكنك إلقاء نظرة على monodoc.xml الملف الذي هو
عادة مثبتة في /usr/lib/monodoc/monodoc.xml.

بمجرد حصولك على جميع الملفات المطلوبة (.zip و .tree و. المصادر) يمكنك تثبيتها
في النظام بالأمر التالي:

cp ProjectName.tree ProjectName.zip ProjectName.source \
`pkg-config monodoc - مصادر متغيرة`

سيقوم ما سبق بنسخ الملفات إلى الدليل الذي سجله Monodoc ؛ أنت
قد تحتاج إلى أذونات الجذر للقيام بذلك. يتم إرجاع الدليل الفعلي بواسطة ملف
pkg-config استدعاء.

MDOC أوامر

mdoc تجمع
يجمع الوثائق للاستخدام داخل monodoc(1) متصفح.

شاهد تجميع mdoc(1) صفحة دليل للتفاصيل.

mdoc تصدير- html
يصدر الوثائق إلى هيكل دليل لملفات HTML.

شاهد mdoc- تصدير- html(1) صفحة دليل للتفاصيل.

mdoc تصدير- msxdoc
تصدر الوثائق في ملف واحد مایکروسوفت XML توثيق تنسيق.

شاهد mdoc- تصدير- msxdoc(1) صفحة دليل للتفاصيل.

mdoc مساعدة
عرض المساعدة الداخلية لأمر معين.

يساعد تجميع mdoc

يساوي:

تجميع mdoc - help

قد يتم سرد أوامر فرعية متعددة في وقت واحد:

يساعد mdoc في تجميع تحديث تصدير html والتحقق من صحة

mdoc تحديث
يقوم بتحديث الوثائق وإضافة وإزالة الأعضاء بناءً على تجميع مرجعي.

شاهد تحديث mdoc(1) صفحة دليل للتفاصيل.

mdoc التحقق من صحة
يتحقق من صحة الوثائق مقابل مخطط التوثيق Mono.

شاهد mdoc- التحقق من صحة(1) صفحة دليل للتفاصيل.

استخدم mdoc عبر الإنترنت باستخدام خدمات onworks.net