mdoc - آنلاین در ابر

برنامه:

نام

mdoc - ابزار مدیریت مستندات مونو

خلاصه

mdoc فرمان [گزینه های] [قوس]

بررسی اجمالی

mdoc یک سیستم مدیریت مستندات مبتنی بر مونتاژ است.

mdoc اجازه ایجاد و به روز رسانی اسناد را می دهد خرد خرد بر اساس محتویات یک
مونتاژ. به اسناد موجود در کد منبع متکی نیست.

مزایای این موارد عبارتند از:

* رمز خوانایی اسناد خوب اغلب (الف) پرمخاطب و (ب) پر می شوند
با مثال (برای مقایسه، اسناد Microsoft .NET Framework را مقایسه کنید،
که اغلب یک صفحه یا تعداد بیشتری از اسناد برای هر عضو، به اسناد JavaDoc است،
که اغلب می تواند یک جمله برای هر عضو باشد.)

قرار دادن مستندات خوب در کد منبع اغلب می تواند منبع را متلاشی کند
فایل، زیرا اسناد می تواند طولانی تر از روش واقعی موجود باشد
ثبت شده.

* بومی سازی. فرمت های اسناد درون منبع (مانند CSC / اسناد) هیچ پشتیبانی ندارند
برای چندین زبان انسانی اگر نیاز به پشتیبانی از بیش از یک زبان انسانی دارید
برای اهداف مستندسازی، 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) مرورگر اسناد، شما باید ابتدا مونتاژ la
مستندات:

mdoc assemble -o ProjectName docs/en

دستور بالا فایل ها را ایجاد می کند ProjectName.tree و ProjectName.zip، در
اضافی ProjectName.sources فایلی باید ارائه شود که در آن توضیح دهد
سیستم کمک مدارک باید متصل شود. این یک فایل XML بسیار ساده است،
مثل این:



<source provider="ecma" basefile="ProjectName"
path="various" />


فایل پیکربندی بالا توضیح می دهد که اسناد در قالب ECMA هستند،
که نام فایل پایه است نام پروژه و اینکه باید به آن متصل شود
"مختلف" بخشی از درخت اسناد اگر می خواهید به گره های مختلف نگاه کنید
تعریف شده در مستندات، می توانید به آن نگاه کنید monodoc.xml فایلی که هست
معمولاً در /usr/lib/monodoc/monodoc.xml.

هنگامی که همه فایل های مورد نیاز (zip.، .tree و .sources) را دارید، می توانید نصب کنید
آنها را با دستور زیر وارد سیستم کنید:

cp ProjectName.tree ProjectName.zip ProjectName.source \
"pkg-config monodoc --variable sourcesdir".

موارد بالا فایل ها را در فهرستی که Monodoc ثبت کرده است کپی می کند. شما
ممکن است برای انجام این کار به مجوزهای ریشه نیاز داشته باشد. دایرکتوری واقعی توسط
پیکربندی pkg فراخوانی

MDOC دستورات

mdoc مونتاژ
اسناد را برای استفاده در داخل جمع آوری می کند monodoc(1) مرورگر.

مشاهده mdoc-assemble(1) صفحه مرد برای جزئیات.

mdoc صادرات-html
اسناد را به یک ساختار دایرکتوری از فایل های HTML صادر می کند.

مشاهده mdoc-export-html(1) صفحه مرد برای جزئیات.

mdoc export-msxdoc
اسناد را به یک فایل صادر می کند مایکروسافت XML مستندات فرمت.

مشاهده mdoc-export-msxdoc(1) صفحه مرد برای جزئیات.

mdoc کمک
مشاهده راهنمای داخلی برای یک دستور داده شده.

mdoc کمک به مونتاژ

برابر است با:

mdoc assemble -- help

ممکن است چندین دستور فرعی به طور همزمان فهرست شود:

mdoc به جمع آوری اعتبار به روز رسانی export-html کمک می کند

mdoc به روز رسانی
اسناد را به روز می کند، اعضا را بر اساس مجمع مرجع اضافه و حذف می کند.

مشاهده mdoc-update(1) صفحه مرد برای جزئیات.

mdoc معتبر ساختن
اسناد را در مقابل طرح مستندات مونو تأیید می کند.

مشاهده mdoc-validate(1) صفحه مرد برای جزئیات.

با استفاده از خدمات onworks.net از mdoc به صورت آنلاین استفاده کنید