این دستور یاردوک است که می تواند در ارائه دهنده هاست رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان ما مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
yardoc - ابزار Ruby برای تولید اسناد برای زبان برنامه نویسی Ruby
خلاصه
حیاط [گزینه های] [فایل های منبع [- فایل های اضافی]] حیاط توضیحات [گزینه های] [فایل های منبع [-
فایل های اضافی]]
شرح
حیاط(1) یک ابزار تولید اسناد قابل توسعه برای زبان برنامه نویسی Ruby است.
کاربر را قادر می‌سازد تا اسناد قابل استفاده و منسجمی را تولید کند که می‌تواند به a صادر شود
تعداد فرمت ها بسیار آسان است، و همچنین از توسعه برای ساخت های Ruby سفارشی پشتیبانی می کند
به عنوان تعاریف سطح کلاس سفارشی.
حیاط، مترادف برای حیاط توضیحات مستندات را از لیست ایجاد می کند فایل های منبع. اگر
این لیست حذف شده است، "{lib,app}/**/*.rb ext/**/*.c" استفاده شده است.
یک مجموعه پایه از گزینه ها را می توان با افزودن a مشخص کرد .yardopts فایل را در مسیر پایه خود قرار دهید
شامل تمام گزینه های اضافی که با فضای خالی از هم جدا شده اند.
OPTIONS
سوالات عمومی گزینه
-b, --db فایل
از یک db.yardoc مشخص شده برای بارگیری یا ذخیره در (پیش‌فرض به .yardoc) استفاده کنید.
--[نه-]تک دسی بل
آیا اشیاء کد باید در یک فایل پایگاه داده ذخیره شوند (پیشرفته)
-n, --بدون خروجی
فقط پایگاه داده .yardoc را تولید کنید، بدون سند.
-c, --use-cache [فایل]
از db.yardoc ذخیره شده برای تولید مستندات استفاده کنید (به طور پیش فرض بدون کش)
--بدون کش
قبل از تجزیه منبع، db.yardoc را پاک کنید.
--[نه-]متراژها [فایل]
اگر آرگومان‌ها باید از FILE خوانده شوند (پیش‌فرض به بله، FILE پیش‌فرض به .yardopts است)
--[نه-]سند
اگر آرگومان ها باید از فایل .document خوانده شوند (به طور پیش فرض بله)
--بدون ذخیره
داده های تجزیه شده را در db yardoc ذخیره نکنید
-- استثناء کردن REGEXP
اگر فایلی با تطابق مسیر مطابقت داشته باشد نادیده می گیرد (regexp)
تولید گزینه های
-- یک فایل
خروجی را به صورت یک فایل واحد تولید می کند
-- لیست
اشیاء را به صورت استاندارد فهرست کنید (به معنی -n)
-- غیر عمومی
روش های عمومی را نشان ندهید (به طور پیش فرض عمومی را نشان می دهد)
--حفاظت شده
نمایش روش های محافظت شده (پخت های پیش فرض محافظت می شوند)
--خصوصی
نمایش روش های خصوصی (پیش فرض خصوصی را پنهان می کند)
-- بدون خصوصی
اشیاء را با تگ @private مخفی کنید
--[no-]api API
اسنادی را برای یک API معین (اشیایی که تگ @api درست را تعریف می کنند) ایجاد می کند.
If --no-api داده می شود، اشیاء را بدون تگ @api نمایش می دهد.
-- embed-mixins
متدهای mixin را در مستندات کلاس جاسازی می کند
-- embed-mixin [مدول]
متدهای mixin را از یک ماژول خاص در مستندات کلاس جاسازی می کند
-- بدون برجسته
بلوک های کد را در خروجی هایلایت نکنید.
-- پیش فرض-بازگشت TYPE
اگر متد فاقد نوع بازگشت باشد نشان داده می شود. (به طور پیش‌فرض به «شیء» می‌رسد)
-- پنهان کردن - باطل - بازگشت
انواع بازگشتی که به عنوان "void" مشخص شده اند را پنهان می کند. (پیش فرض نشان داده شده است)
--پرس و جو پرس و جو
فقط اشیایی را نشان دهید که با یک جستجوی خاص مطابقت دارند
--عنوان TITLE
عنوان خاصی را به اسناد HTML اضافه کنید
-r, -- readme, -- اصلی فایل
فایل readme به عنوان صفحه عنوان اسناد استفاده می شود.
--فایل ها FILE1,FILE2، ...
هر فایل استاتیک اضافی جدا شده با کاما (به عنوان مثال، سؤالات متداول)
-- دارایی از[:به]
یک فایل یا دایرکتوری برای کپی کردن در دایرکتوری خروجی پس از تولید
-o, --output-dir PATH
دایرکتوری خروجی (به طور پیش فرض به ./doc)
-m, -- نشانه گذاری MARKUP
سبک نشانه گذاری مورد استفاده در اسناد، مانند textile، markdown یا rdoc (پیش فرض به rdoc).
-M MARKUP_PROVIDER
کتابخانه مورد استفاده برای پردازش نشانه گذاری را لغو می کند
--ارائه دهنده نشانه گذاری
قالب بندی (نام جواهر را مشخص کنید)
-- مجموعه حروف رو به جلو
نویسه تنظیم شده برای استفاده در هنگام تجزیه فایل ها (پیش فرض منطقه سیستم است)
-t, --قالب قالب
قالب مورد استفاده (پیش فرض به "پیش فرض")
-p, -مسیر الگو PATH
مسیر الگو برای جستجوی الگوها (با -t استفاده می شود).
-f, --قالب FORMAT
فرمت خروجی برای الگو (به طور پیش فرض به html).
--بدون آمار
آمار چاپ نکنید
--محلی محلی
محلی برای اسناد تولید شده (به طور پیش فرض به en).
--po-dir DIR
دایرکتوری که فایل‌های .po دارد (پیش‌فرض #{YARD::Registry.po_dir} است).
برچسب گزینه ها:
(TAG:TITLE به نظر می رسد: 'اضافه بار:بیش از حد بارگیری شده روش')
-- برچسب TAG:TITLE
یک ابرداده رایگان جدید @tag را ثبت می کند
--type-tag TAG:TITLE
با فیلد انواع اختیاری تگ کنید
--type-name-tag TAG:TITLE
برچسب با انواع اختیاری و یک فیلد نام
---برچسب نام TAG:TITLE
با یک فیلد نام تگ کنید
- برچسب عنوان TAG:TITLE
با خط اول به عنوان فیلد عنوان تگ کنید
--hide-tag TAG
یک برچسب از قبل تعریف شده را از قالب ها پنهان می کند
---برچسب TAG
یک برچسب را به عنوان گذرا علامت گذاری می کند
- تگ غیر گذرا TAG
یک برچسب را به عنوان غیر گذرا علامت گذاری می کند
دیگر گزینه ها:
-e, --بار فایل
یک اسکریپت Ruby برای بارگیری قبل از اجرای دستور.
-- پلاگین پلاگین
بارگیری یک افزونه YARD (گوهر با پیشوند «yard-»)
-- میراث
از تجزیه کننده و کنترل کننده های روبی سبک قدیمی استفاده کنید. همیشه در 1.8.x روشن است.
--بی خطر
حالت امن را برای این مثال فعال کنید
-q, --ساکت
هیچ هشداری نشان داده نشود.
-- پرحرف
نمایش اطلاعات بیشتر
- رفع اشکال
نمایش اطلاعات اشکال زدایی
-- ردیابی
نمایش ردپای پشته
-v, - نسخه
نمایش نسخه.
-h, --کمک
این کمک را نشان دهید.
مثال ها
حیاط -o "مستندات/" - "سوالات متداول" "مجوز"
مثال بالا اسناد را برای فایل های "lib/**/*.rb" به "documentation/" خروجی می دهد.
از جمله فایل های اضافی "سؤالات متداول" و "LICENSE".
با استفاده از خدمات onworks.net از yardoc به صورت آنلاین استفاده کنید
