این دستور mdoc-update است که می تواند در ارائه دهنده هاست رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان ما مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
به روز رسانی mdoc - mdoc(5) پشتیبانی از فرمت اسناد
خلاصه
mdoc به روز رسانی [گزینه‌ها]* مجموعه‌ها
شرح
mdoc به روز رسانی مسئولیت موارد زیر است:
* ایجاد خرد مستندات بر اساس مجالس. فرآیند ایجاد خرد خواهد بود
ایجاد جدید mdoc(5) فایل های XML برای هر نوع در داخل مجالس، و تهیه کنید
خردهای مستند برای هر عضو از آن انواع.
* به روز رسانی خرد مستندات بر اساس مجالس. موجود mdoc(5) اسناد می تواند
به روز شود تا تغییرات درون را منعکس کند مجالسمانند انواع و اعضای اضافه شده،
با حفظ اسناد موجود
در برخی شرایط محدود، تغییر نام‌ها ردیابی می‌شوند و به حداقل می‌رسد
بار اسناد زمانی که به عنوان مثال یک پارامتر تغییر نام می دهد.
mdoc به روز رسانی به اسناد موجود در کد منبع تکیه نمی کند، اگرچه می تواند وارد کند
نظرات اسناد XML از طریق -i گزینه.
دیدن mdoc(1) و mdoc(5) برای اطلاعات بیشتر
OPTIONS
--حذف
اجازه دادن mdoc به روز رسانی برای حذف اعضا از فایل های اسناد تنها اعضا
حذف شده اعضایی هستند که دیگر در داخل حضور ندارند مجالس نیستند
موجود در هر نسخه اسمبلی دیگر.
اگر یک نوع دیگر وجود ندارد، فایل مستندات موجود است نه حذف شده است، اما است
در عوض تغییر نام داشتن یک .برداشتن افزونه.
تشخیص نسخه با //AssemblyVersion عناصر؛ اگر وجود ندارد
//AssemblyVersion عناصر برای یک معین or ، سپس خواهد بود
تغییر نام داد و/یا حذف خواهد شد.
--استثناها[=منابع]
تجربی. این 100٪ قابل اعتماد نیست، اما در نظر گرفته شده است که به عنوان کمکی برای آن عمل کند
نویسندگان اسناد
اعضای اعضا را بازرسی کنید تا مشخص کنید چه استثنایی می تواند از آن ایجاد شود
عضو.
منابع یک لیست اختیاری جدا شده با کاما از منابع زیر است که باید باشد
موارد استثنا را جستجو کرد:
اضافه شده فقط تولید کنید عناصر برای اعضا
در طول اجرای برنامه فعلی اضافه شده است.
این باعث می شود mdoc-update دوباره تولید نشود
عناصر برای همه اعضا (و بنابراین
از درج مجدد برای اعضایی که دارای آن بودند جلوگیری می کند
عناصر حذف شده است).
همه استثناهای ایجاد شده در خود عضو را پیدا کنید،
ارجاع به اعضای همان مجمع،
و ارجاع به اعضا در وابسته
مجامع
asm استثناهای ایجاد شده در خود عضو را بیابید و
ارجاع به اعضای همان مجمع
به عنوان عضو
depasm استثناهای ایجاد شده در خود عضو و
ارجاع به اعضای وابسته
مجامع
If منابع ارائه نشده است (به طور پیش فرض)، سپس فقط استثناها در داخل ایجاد می شوند
خود عضو مستند خواهد شد.
محدودیت ها: جستجوی استثنا در حال حاضر با جستجوی عبارت اجرا می شود
انواع استثنایی که به صراحت بر اساس انواع شناخته شده زمان کامپایل ایجاد می شوند.
این دارای محدودیت های زیر است:
* این استثنائاتی را که به طور ضمنی در IL هستند، پیدا نمی کند، مانند
NullReferenceException و IndexOutOfRangeException.
* این استثناهایی را پیدا می کند که هستند نه پرتاب شده، به عنوان مثال
خلأ عمومی CreateAnException ()
{
استثنا e = استثنا جدید ();
}
* این کار «دنبال» تماس‌های نماینده و واسط نخواهد بود:
عمومی void UsesDelegates ()
{
تابع a = x => {trow new Exception ();};
الف (4)؛
}
تابع UsesDelegates() هیچ استثنایی مستند نخواهد داشت.
* این موارد استثناهایی را پیدا می کند که "نمی توانند اتفاق بیفتند"، مانند
ArgumentNullExceptions برای آرگومان هایی که "معروف به غیر تهی" هستند:
خلأ عمومی A ()
{
B ("این پارامتر تهی نیست")؛
}
فضای خالی عمومی B (رشته s)
{
اگر (s == پوچ)
پرتاب ArgumentNullException جدید ("s");
}
برای موارد فوق، اگر --exceptions=asm سپس ارائه می شود آ() مستند خواهد شد
به عنوان پرتاب یک ArgumentNullException، که نمی تواند اتفاق بیفتد.
-f=پرچم
یک پرچم برای تغییر رفتار مشخص کنید. پرچم های معتبر عبارتند از:
نسخه های بدون اسمبلی
مشاهده نسخه های -fno-assembly مستندات، در زیر
نسخه های -fno-assembly
تولید نکنید /Type/AssemblyInfo/AssemblyVersion و
/Type/Members/Member/AssemblyInfo عناصر.
این برای جلوگیری از "چرخش" در طول به روز رسانی مفید است. به طور معمول، اگر یک نوع یا عضو
تغییر نکرده است اما نسخه اسمبلی تغییر کرده است، سپس همه انواع و ممبرها
برای گنجاندن یک مورد جدید به روز می شود //AssemblyVersion عنصر، در نتیجه افزایش می یابد
مقدار تغییراتی که قبل از انجام نیاز به بررسی دارند (با فرض اینکه همه تغییرات هستند
در واقع قبل از انجام بررسی شده است).
هشدار: این اراده تعامل بد با --حذف گزینه، به عنوان --حذف با استفاده از
//AssemblyVersion عناصر برای پیگیری تغییرات نسخه بنابراین، اگر عضوی دارید
که در نسخه اسمبلی اولیه وجود دارد و در نسخه بعدی حذف می شود
نسخه اسمبلی، مانند System.Text.UTF8Encoding.GetBytes(رشته) (که است
موجود در NET 1.0 اما نه در NET 2.0)، پس از آن عضو حذف خواهد شد.
--حذف نسخه های -fno-assembly گزینه ها مشخص شده است، عضو در یک حضور داشت
نسخه قبلی اسمبلی، و نسخه فعلی اسمبلی اینطور نیست
شامل عضو باشد.
در نتیجه، این گزینه باید فقط مشخص می شود که آیا انواع و اعضا خواهد بود هرگز
از یک مجمع حذف شود
-i, --وارد كردن=فایل
اسناد واردات در داخل یافت شد فایل.
فایل ممکن است حاوی هر کدام باشد CSC / اسناد XML یا ECMA-335 XML
-L, --lib=دایرکتوری
اضافه کردن دایرکتوری به مسیر جستجوی اسمبلی، به طوری که وابستگی های مجالس می توان
بدون مستندسازی آن مجامع پیدا شود.
-o, -- خارج=دایرکتوری
خردهای تولید شده را در آن قرار دهید دایرکتوری.
هنگام به روز رسانی اسناد، دایرکتوری همچنین دایرکتوری منبع است.
-r=مونتاژ
مونتاژ وابستگی برای یکی از مجالس که باید نه مستند باشد اما
برای پردازش یکی از مجالس. دایرکتوری حاوی مونتاژ به
مسیر جستجوی اسمبلی
این گزینه معادل مشخص کردن است -L `عنوان مونتاژ`.
--از آنجا که=نسخه
چه زمانی به روز رسانی اگر با یک نوع یا عضو مواجه شد، مستندسازی برای یک مجموعه
که در نسخه قبلی اسمبلی وجود نداشت a <از زمانی که
نسخه="نسخه"/> عنصر درج خواهد شد.
--نوع=TYPE
فقط اسناد را برای نوع به روز کنید TYPE.
-h، -؟، --کمک
نمایش یک پیام راهنما و خروج.
با استفاده از خدمات onworks.net از mdoc-update آنلاین استفاده کنید
