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

برنامه:

نام

rdoc2.3 - ایجاد مستندات از فایل های اسکریپت Ruby

خلاصه

rdoc2.3 [گزینه‌ها] [نام‌ها...]

شرح

فایل‌ها تجزیه می‌شوند و اطلاعاتی که در آنها وجود دارد، قبل از خروجی جمع‌آوری می‌شوند
تولید شده. این اجازه می دهد تا ارجاعات متقابل بین همه فایل ها حل شود. اگر یک نام a است
دایرکتوری، از آن عبور می شود. اگر هیچ نامی مشخص نشده باشد، تمام فایل‌های Ruby در حال حاضر
دایرکتوری (و زیر شاخه ها) پردازش می شوند.

فرمت‌کننده‌های خروجی موجود: chm، html، ri، xml

برای اطلاعات در مورد جایی که خروجی می رود، از:
rdoc --help-output

OPTIONS

--دسترس، -A نام دسترسی[,..]
لیستی از متدهای کلاس اضافی جدا شده با کاما که باید مانند آنها رفتار شود
'attr_reader' و دوستان. گزینه ممکن است تکرار شود. هر نام دسترسی ممکن است داشته باشد
'=text' اضافه شد، در این صورت آن متن در جایی ظاهر می شود که r/w/rw برای آن ظاهر می شود
لوازم جانبی معمولی

--همه، -a
شامل تمام متدها (نه فقط عمومی) در خروجی.

-- مجموعه حروف، -c کاراکتر
مجموعه کاراکترهای HTML را مشخص می کند

-- اشکال زدایی، -D
موارد زیادی را در موارد داخلی نمایش می دهد

-- نمودار، -d
ایجاد نمودارهایی که ماژول ها و کلاس ها را نشان می دهد. برای استفاده به نقطه V1.8.6 یا بالاتر نیاز دارید
گزینه --diagram به درستی نقطه در دسترس است از
<URL:http://www.research.att.com/sw/tools/graphviz/>.

-- مستثنی کردن -x الگو
فایل ها یا دایرکتوری های مطابق با الگو را پردازش نکنید. فایل هایی که به صراحت در
خط فرمان هرگز مستثنی نخواهد شد.

--افزونه، -E جدید = قدیمی
با فایل هایی که با .new ختم می شوند طوری رفتار کنید که گویی با .old ختم می شوند. با استفاده از '-E cgi=rb' خواهد شد
باعث می شود xxx.cgi به عنوان یک فایل روبی تجزیه شود

-- جعبه های فایل، -F
کلاس ها در جعبه هایی قرار می گیرند که نشان دهنده فایل ها هستند، جایی که این کلاس ها در آن قرار دارند.
کلاس هایی که بین بیش از یک فایل به اشتراک گذاشته می شوند با لیست فایل هایی که به اشتراک گذاشته می شوند نشان داده می شوند
آنها اگر نمودار -- آزمایشی داده نشود، بی‌صدا کنار گذاشته می‌شود.

--fmt، -f نام قالب
فرمت خروجی را تنظیم کنید (به زیر مراجعه کنید).

--کمک، -h
استفاده از چاپ

- خروجی کمک، -O
گزینه های مختلف خروجی را توضیح دهید.

- فرمت تصویر، -I gif|png|jpg|jpeg
فرمت تصویر خروجی را برای نمودارها تنظیم می کند. می تواند png، gif، jpeg، jpg باشد. اگر این گزینه
حذف شده است، png استفاده می شود. نیاز به -- نمودار.

--عبارتند از، -i dir[,dir...]
لیست دایرکتوری هایی را که باید جستجو شوند را تنظیم کنید (یا به آن اضافه کنید) در صورت رضایت :include:
درخواست ها. می توان بیش از یک بار استفاده کرد.

- منبع درون خطی، -S
کد منبع روش را به صورت درون خطی نشان دهید، نه از طریق یک پیوند بازشو.

-- شماره های خط، -N
شامل شماره خطوط در کد منبع

-- اصلی، -m نام
نام صفحه اولیه نمایش داده شده خواهد بود.

--ادغام، -M
هنگام ایجاد خروجی ri، کلاس های پردازش شده را در کلاس های مستند قبلی ادغام کنید
از نام

-- یک فایل، -1
تمام خروجی ها را در یک فایل قرار دهید.

--op، -o دیر
دایرکتوری خروجی را تنظیم کنید

--opname, -n نام
نام خروجی را تنظیم کنید هیچ تاثیری برای HTML ندارد.

-- بی بند و باری، -p
هنگام مستندسازی فایلی که حاوی یک ماژول یا کلاس است که در سایر موارد نیز تعریف شده است
فایل‌ها، همه موارد مربوط به آن ماژول/کلاس را در صفحه هر فایل نشان دهید. به طور پیش فرض، فقط
نمایش موارد تعریف شده در آن فایل خاص.

--ساکت، -q
وقتی تجزیه می کنیم پیشرفت را نشان ندهید.

--ری، -r
تولید خروجی برای استفاده توسط 'ri'. فایل ها در دایرکتوری '.rdoc' ذخیره می شوند
تحت فهرست اصلی شما مگر اینکه توسط یک پارامتر --op بعدی لغو شود، بنابراین خیر
امتیازات ویژه مورد نیاز است.

--ri-site, -R
تولید خروجی برای استفاده توسط 'ri'. فایل ها در یک فهرست سایت ذخیره می شوند،
آنها را در دسترس دیگران قرار می دهد، بنابراین امتیازات خاصی مورد نیاز است.

--ri-system، -Y
تولید خروجی برای استفاده توسط 'ri'. فایل ها در یک فهرست در سطح سیستم ذخیره می شوند،
آنها را در دسترس دیگران قرار می دهد، بنابراین امتیازات خاصی مورد نیاز است. این گزینه است
در نظر گرفته شده برای استفاده در نصب روبی.

--نمایش-هش، -H
نام فرم #name در یک نظر، یک پیوند احتمالی به یک روش نمونه است
نام. هنگامی که نمایش داده می شود، "#" حذف می شود مگر اینکه این گزینه مشخص شده باشد.

--سبک، -s شیوه نامه-url
URL یک شیوه نامه جداگانه را مشخص می کند.

-عرض برگه، -w n
عرض کاراکترهای برگه را تنظیم کنید (پیش فرض 8).

--قالب، -T نام الگو
الگوی مورد استفاده در هنگام تولید خروجی را تنظیم کنید.

--عنوان، -t متن
متن را به عنوان عنوان خروجی تنظیم کنید.

--نسخه، -v
نمایش نسخه RDoc

--webcvs، -W آدرس
یک URL برای پیوند دادن به صفحه وب به CVS مشخص کنید. اگر URL حاوی یک است
'%s'، نام فایل به آن اضافه خواهد شد.

جولای 2014 RDOC2.3(1)

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