این دستور fpdoc-3.0.0 است که می تواند در ارائه دهنده هاست رایگان OnWorks با استفاده از یکی از چندین ایستگاه کاری آنلاین رایگان ما مانند Ubuntu Online، Fedora Online، شبیه ساز آنلاین ویندوز یا شبیه ساز آنلاین MAC OS اجرا شود.
برنامه:
نام
fpdoc - تولید کننده اسناد واحد FPC Pascal.
خلاصه
fpdoc --input=inputcommand [--output=output] [--format=fmt] [--descr=descriptionfile]
[--package=packagename] [گزینه‌ها]
توضیحات:
fpdoc فایل منبع واحد پاسکال رایگان را اسکن می کند و برای آن مستندات ایجاد می کند. را
اسناد می تواند در فرمت های مختلف باشد (در حال حاضر HTML و LaTeX) می تواند انواع مختلفی را بخواند
فایل های توضیحات که حاوی توضیحات نمادهای مختلف موجود در واحد هستند
فایل.
استفاده
می توانید استناد کنید fpdoc به عنوان تنها آرگومان مورد نیاز "ورودی" و "بسته"
استدلال ها حداقل باید حاوی نام فایل واحد مربوط به مستندات باشد
باید تولید شود و نام بسته ای که واحد به آن تعلق دارد.
گزینه
fpdoc چندین گزینه دارد که اکثر آنها اختیاری هستند، در اکثر موارد از پیش فرض ها استفاده می شود.
--محتوا
این گزینه می گوید fpdoc برای تولید یک فایل محتوا یک فایل محتوا حاوی یک لیست است
از تمام لنگرها (برچسب ها) ممکن در فایل مستندات تولید شده و می توانید
برای ایجاد پیوندهای متقابل در اسناد برای واحدهای مختلف، با استفاده از
--وارد كردن گزینه.
--cputarget = ارزش
این گزینه می گوید fpdoc برای کدام CPU اسناد تولید کند. این به سادگی
ماکروهای CPU مناسب را تعریف می کند.
--descr=decfile
این گزینه نام یک فایل توضیحات را مشخص می کند شرح دادن که حاوی
اسناد واقعی برای واحد این گزینه می تواند چندین بار داده شود، برای
چندین فایل توضیحات
--descr-dir=dir
این گزینه نام دایرکتوری با فایل های توضیحات XML را مشخص می کند دیر
این گزینه را می توان چندین بار برای چندین دایرکتوری توضیحات داده شد. این
گزینه معادل مشخص کردن تمام فایل های دایرکتوری با -descr است
گزینه.
-- اصلاح نکنید
این گزینه به fpdoc می گوید که فضای سفید را در فایل های XML کوتاه نکند. به صورت پیش فرض،
فضای خالی از ورودی بریده می شود که می تواند عوارض جانبی نامطلوبی داشته باشد
به عنوان مثال برچسب های PRE.
-- خشک اجرا شود
این گزینه می گوید fpdoc نه برای تولید هیچ خروجی، بلکه فقط تمام ورودی ها را تجزیه کنید. این
می توان با گزینه verbose برای بررسی اینکه چه خطاهایی در آن باقی مانده است استفاده کرد
اسناد یا مواردی که هنوز گم شده است.
--format=fmt
فرمت را مشخص می کند fmt که در آن مستندات تولید خواهد شد. در حال حاضر،
فرمت های زیر شناخته شده است:
hm CHM با 8.3 نام فایل منطبق، بیشتر برای ویندوز.
dxml خروجی XML سازگار با دلفی
HTM HTML با 8.3 مطابق نام فایل.
اچ تی ام ال HTML با نام فایل های طولانی.
ipf خروجی IPF (فرمت OS/2، می تواند با docview از fpGUI استفاده شود).
xhtml XHTML با نام فایل های طولانی.
شیرابه LaTex، که از سبک fpc.sty استفاده شده توسط مستندات Free Pascal استفاده می کند.
مرد خروجی صفحه man (صفحات دستی یونیکس، یک صفحه در هر شناسه).
RTF خروجی RTF
کلیپ برد چند منظوره خروجی متن ساده
xml-struct
XML ساختار یافته
--کمک نمایش خلاصه گزینه خط فرمان.
---محافظت شده
به طور پیش‌فرض، اسناد شامل توضیحات و فهرست‌های محافظت‌شده می‌شود
فیلدها و متدها در کلاس ها یا اشیاء. این گزینه این رفتار را تغییر می دهد. اگر این
مشخص شده است، هیچ سندی برای این روش ها ایجاد نخواهد شد. توجه داشته باشید که
متدهای عمومی یا ویژگی هایی که به این روش های محافظت شده ارجاع می دهند دارای یک خواهند بود
پیوند آویزان (یعنی در دسترس نیست).
--html-search=link
یک ورودی برای یک صفحه جستجوی HTML در مکان اضافه می کند پیوند در سرفصل های
صفحات HTML تولید شده صفحه جستجو ارائه نشده است، این باید ساخته شود و
توسط کاربر ارائه شده است.
--import=impfile
یک فایل محتوا را وارد می کند مخدوش کردن از مجموعه اسناد دیگری از این می توان استفاده کرد
حل و فصل ارجاع به عناصر موجود در این فایل مستندات دیگر.
--input=cmd
این گزینه می گوید fpdoc چه فایل ورودی باید استفاده شود بحث و جدل CMD می تواند
فقط یک نام فایل، اما همچنین می تواند یک خط فرمان کامل کامپایلر با گزینه هایی باشد که
مربوط به اسکن منبع پاسکال است: تعریف، شامل فایل ها، گزینه های نحوی،
همانطور که در هنگام کامپایل کردن فایل به کامپایلر پاسکال رایگان مشخص می شوند. اگر
از یک دستور کامل استفاده می شود، سپس باید آن را در یک یا دو گیومه قرار داد،
بنابراین پوسته آنها را به قطعات نمی شکند. امکان تعیین چندگانه وجود دارد
دستورات ورودی؛ آنها یک به یک مورد بررسی قرار می گیرند و مستندات نیز انجام می شود
برای هر یک از آنها ایجاد می شود.
--input-dir=dir
این گزینه می گوید fpdoc برای افزودن همه فایل‌های .pas و .pp در فهرست نام‌گذاری شده CMD as
فایل های ورودی را به مستندساز. این معادل مشخص کردن تمام فایل‌ها در
دایرکتوری با -- ورودی فرمان
--lang=زبان
زبان فایل خروجی را تنظیم می کند. این به طور عمده رشته های مورد استفاده را تنظیم می کند
سرصفحه ها در بخش های مختلف فایل های مستندات (به طور پیش فرض در آنها قرار دارند
انگلیسی). در حال حاضر، گزینه های معتبر هستند
de آلمانی
fr فرانسوی
nl هلندی
--latex-extension=ext
پسوند را برای استفاده از فایل LaTeX تنظیم می کند EXT پیش فرض است تکس (با .
(نقطه) شامل).
--لاتکس-هایلایت
برجسته کننده نحو لاتکس داخلی را روشن می کند. این هنوز اجرایی نشده است. توسط
پیش‌فرض، برجسته‌سازی نحو توسط بسته نحوی ارائه می‌شود که با fpc ارائه می‌شود.
--mo-dir=dir
این گزینه می گوید fpdoc کجا می توان فایل های ترجمه ای را جستجو کرد که می توان از آنها استفاده کرد
بین المللی کردن خروجی fpdoc
--ostarget=ارزش
این گزینه می گوید fpdoc برای کدام سیستم عامل اسناد تولید کند. این
به سادگی ماکروهای سیستم عامل مناسب را تعریف می کند.
--output=نام
این گزینه می گوید fpdoc جایی که فایل خروجی باید تولید شود. چگونه این گزینه
تفسیر بستگی به قالبی دارد که استفاده می شود. برای لاتکس، نام تفسیر می شود
به عنوان نام فایل برای فایل متنی. برای همه فرمت های دیگر، نام به عنوان تعبیر می شود
دایرکتوری که در آن تمام فایل های مستندات نوشته می شود. دایرکتوری خواهد بود
اگر هنوز وجود نداشته باشد ایجاد شده است. استاندارد این برابر با نام بسته است.
--package=packagename
نام بسته را مشخص می کند. همه واحدها به عنوان بخشی از مستند خواهند شد نام بسته ,
که نام فایل یا دایرکتوری خروجی پیش فرض نیز می باشد. فقط گره های مستندسازی
در داخل یک گره بسته با این نام هنگام مستندسازی در نظر گرفته می شود.
--parse-impl
(تجربی) سعی کنید پیاده سازی یک واحد را نیز تجزیه کنید، این می تواند برای آن استفاده شود
بررسی نحو
--پروژه=فایل
این گزینه می گوید fpdoc برای خواندن همه گزینه ها از یک فایل پروژه. این یک XML است
فایل، لطفا برای اطلاعات بیشتر در مورد فرمت این، به مستندات مراجعه کنید
فایل.
--نمایش-خصوصی
به طور پیش فرض، هیچ سندی برای روش ها یا فیلدهای خصوصی ایجاد نمی شود. این
گزینه علل fpdoc برای ایجاد مستندات برای این روش ها نیز.
-- پرحرف
به طور پیش فرض، fpdoc با خروجی کم است این به fpdoc می گوید که مقدار بیشتری تولید کند
اطلاعاتی در مورد کاری که انجام می دهد
--warn-no-node
اگر این گزینه مشخص شده باشد، fpdoc اگر a را پیدا نکند یک اخطار صادر می کند
گره توصیف برای شناسه ای که در حال مستندسازی است.
--write-project=file
اگر این گزینه مشخص شده باشد، fpdoc یک فایل پروژه fpdoc (در
نام فایل مشخص شده) که با گزینه های خط فرمان داده شده مطابقت دارد.
با استفاده از خدمات onworks.net از fpdoc-3.0.0 به صورت آنلاین استفاده کنید
