fpdoc-3.0.0 - عبر الإنترنت في السحابة

برنامج:

اسم

fpdoc - مولد توثيق وحدة FPC Pascal.

موجز

com.fpdoc --input = أمر الإدخال [- Output = الإخراج] [--format = fmt] [--descr = ملف الوصف]
[--package = packagename] [خيارات]

الوصف

com.fpdoc يمسح ملف مصدر وحدة Free Pascal ويولد توثيقًا له. ال
يمكن أن يكون التوثيق بتنسيقات مختلفة (حاليًا HTML و LaTeX) ويمكنه قراءة العديد من الأشكال
ملفات الوصف التي تحتوي على وصف للرموز المختلفة الموجودة في الوحدة
ملف.

الأستعمال

يمكنك استدعاء com.fpdoc مع الوسيطة الوحيدة المطلوبة "المدخلات" و "الحزمة"
الحجج. يجب أن يحتوي على الأقل على اسم ملف الوحدة المراد توثيقه
يجب إنشاء اسم الحزمة التي تنتمي إليها الوحدة.

مزيد من الخيارات

com.fpdoc لديها العديد من الخيارات ، معظمها اختياري ، وسيتم استخدام الإعدادات الافتراضية في معظم الحالات.

--محتوى
هذا الخيار يقول com.fpdoc لإنشاء ملف محتوى. يحتوي ملف المحتوى على قائمة
من جميع المراسي الممكنة (الملصقات) في ملف التوثيق الذي تم إنشاؤه ، ويمكن
يتم استخدامها لإنشاء روابط متقاطعة في التوثيق لوحدات مختلفة ، باستخدام
--يستورد الخيار.

--cputarget = القيمة
هذا الخيار يقول com.fpdoc لأي وحدة معالجة مركزية لإنشاء الوثائق. هذا ببساطة
يحدد وحدات الماكرو المناسبة لوحدة المعالجة المركزية.

--descr = descfile
يحدد هذا الخيار اسم ملف الوصف ديسفيل الذي يحتوي على
التوثيق الفعلي للوحدة. يمكن إعطاء هذا الخيار عدة مرات ، ل
عدة ملفات وصف.

--descr-dir = dir
يحدد هذا الخيار اسم الدليل بملفات وصف XML ، المسماة دير
يمكن إعطاء هذا الخيار عدة مرات ، للعديد من دلائل الوصف. هذا
الخيار يكافئ تحديد جميع الملفات في الدليل باستخدام --descr
الخيار.

- لا تقليم
يخبر هذا الخيار fpdoc بعدم قطع المسافات البيضاء في ملفات XML. بشكل افتراضي،
يتم قطع المسافة البيضاء من الإدخال ، والتي يمكن أن يكون لها آثار جانبية غير مرغوب فيها في
على سبيل المثال علامات PRE.

--ركض جاف
هذا الخيار يقول com.fpdoc ليس لتوليد أي إخراج ، ولكن فقط تحليل كل المدخلات. هذا
يمكن استخدامها مع الخيار المطول للتحقق من الأخطاء المتبقية في ملف
الوثائق ، أو ما لا يزال مفقودًا.

- صيغة = fmt
يحدد التنسيق معاهدة المواد الانشطارية حيث سيتم إنشاء الوثائق. حاليا
التنسيقات التالية معروفة:

آلية تبادل المعلومات CHM مع أسماء ملفات 8.3 مطابقة ، للنوافذ في الغالب.

com.dxml إخراج XML متوافق مع دلفي.

هتم HTML مع 8.3 مطابقة أسماء الملفات.

أتش تي أم أل HTML مع أسماء ملفات طويلة.

IPF إخراج IPF (تنسيق OS / 2 ، يمكن استخدامه مع docview من fpGUI).

xhtml XHTML بأسماء ملفات طويلة.

اللاتكس LaTex ، الذي يستخدم نمط fpc.sty المستخدم في وثائق Free Pascal.

رجل إخراج صفحة الدليل (صفحات دليل يونكس ، صفحة واحدة لكل معرّف).

RTF خرج RTF.

TXT إخراج نص عادي.

xml- هيكل
XML منظم.

--مساعدة إظهار ملخص خيار سطر الأوامر.

- إخفاء محمي
بشكل افتراضي ، ستتضمن الوثائق الأوصاف والقوائم المحمية
الحقول والأساليب في الفئات أو الكائنات. هذا الخيار يغير هذا السلوك؛ لو أنه
محددًا ، لن يتم إنشاء أي وثائق لهذه الأساليب. لاحظ أن
عندئذٍ سيكون للطرق أو الخصائص العامة التي تشير إلى هذه الطريقة المحمية الامتداد
الارتباط المتدلي (أي غير متوفر).

--html-search = link
يضيف إدخالاً لصفحة بحث HTML في الموقع الصفحة في رؤوس
ولدت صفحات HTML. لا توجد صفحة بحث متوفرة ، يجب أن يتم ذلك و
المقدمة من المستخدم.

- الاستيراد = impfile
يستورد ملف محتوى عفريت من مجموعة وثائق أخرى. يمكن استخدام هذا ل
حل الإشارات إلى العناصر الموجودة في ملف التوثيق الآخر هذا ؛

- الإدخال = cmd
هذا الخيار يقول com.fpdoc ما ملف الإدخال الذي يجب استخدامه. الحجة كمد يمكن أن يكون
مجرد اسم ملف ، ولكن يمكن أيضًا أن يكون سطر أوامر مترجم كامل مع خيارات
تتعلق بمسح مصدر باسكال: يحدد ، يشمل الملفات ، خيارات بناء الجملة ،
كما سيتم تحديدها لمترجم باسكال المجاني عند تجميع الملف. لو
يتم استخدام أمر كامل ، ثم يجب وضعه بين علامتي اقتباس مفردة أو مزدوجة ،
لذلك لن تكسرها الصدفة إلى أجزاء. من الممكن تحديد متعددة
أوامر الإدخال سيتم التعامل معهم واحدًا تلو الآخر ، وسيتم التوثيق
ولدت لكل منهم.

--input-dir = dir
هذا الخيار يقول com.fpdoc لإضافة كافة ملفات .pas و .pp في الدليل المسمى كمد as
إدخال الملفات إلى الموثق. هذا يعادل تحديد جميع الملفات في
الدليل مع --إدخال أمر.

--lang = لغة
يضبط لغة ملف الإخراج. سيؤدي هذا بشكل أساسي إلى ضبط السلاسل المستخدمة
الرؤوس في أجزاء مختلفة من ملفات التوثيق (افتراضيًا تكون موجودة في
إنجليزي). حاليًا ، الخيارات الصالحة هي

de ألمانية.

fr الفرنسية.

nl هولندي.

- التمديد اللاتكس = تحويلة
يضبط الامتداد المراد استخدامه لملف LaTeX على تحويلة الافتراضي هو .تكس (مع .
(نقطة) متضمنة).

- تسليط الضوء على اللاتكس
يقوم بالتبديل على أداة تمييز بناء جملة لاتكس داخلية. هذا لم يتم تنفيذه بعد. بواسطة
افتراضيًا ، يتم توفير تمييز بناء الجملة بواسطة حزمة بناء الجملة التي تأتي مع fpc.

--mo-dir = dir
هذا الخيار يقول com.fpdoc مكان البحث عن ملفات الترجمة التي يمكن استخدامها
تدويل إخراج fpdoc.

- الهدف = القيمة
هذا الخيار يقول com.fpdoc لأي نظام تشغيل لإنشاء الوثائق. هذا
يعرّف ببساطة وحدات الماكرو الخاصة بنظام التشغيل.

- الإخراج = الاسم
هذا الخيار يقول com.fpdoc حيث يجب إنشاء ملف الإخراج. كيف هذا الخيار
يتم تفسيره بناءً على التنسيق المستخدم. لمادة اللاتكس ، الاسم يتم تفسيره
كاسم ملف tex. لجميع التنسيقات الأخرى ، الاسم يتم تفسيره على أنه
الدليل حيث سيتم كتابة جميع ملفات التوثيق. سيكون الدليل
تم إنشاؤه إذا لم يكن موجودًا بعد. المعيار هذا يساوي اسم الحزمة.

- حزمة = اسم حزمة
يحدد اسم الحزمة. سيتم توثيق جميع الوحدات كجزء من اسم حزمة ,
وهو أيضًا اسم ملف الإخراج الافتراضي أو الدليل. عقد التوثيق فقط
داخل عقدة حزمة بهذا الاسم سيتم أخذها في الاعتبار عند التوثيق.

- parse-impl
(تجريبي) حاول تحليل تنفيذ الوحدة أيضًا ، يمكن استخدام هذا من أجلها
فحص النحو.

- مشروع = ملف
هذا الخيار يقول com.fpdoc لقراءة جميع الخيارات من ملف المشروع. هذا ملف XML
الملف ، يرجى الاطلاع على الوثائق للحصول على مزيد من المعلومات حول تنسيق هذا
ملف.

- إظهار-خاص
بشكل افتراضي ، لا يتم إنشاء أي وثائق للأساليب أو الحقول الخاصة. هذا
أسباب الخيار com.fpdoc لإنشاء وثائق لهذه الأساليب أيضًا.

- الإسراف
افتراضيا، com.fpdoc متناثر مع الإخراج. هذا يخبر fpdoc لتوليد المزيد
معلومات حول ما تفعله.

- تحذير لا عقدة
إذا تم تحديد هذا الخيار ، com.fpdoc سيصدر تحذيرًا إذا لم يعثر على ملف
عقدة الوصف لمعرف تقوم بتوثيقه.

- كتابة مشروع = ملف
إذا تم تحديد هذا الخيار ، com.fpdoc سيكتب ملف مشروع fpdoc (إلى ملف
اسم الملف المحدد) الذي يتوافق مع خيارات سطر الأوامر المحددة.

استخدم fpdoc-3.0.0 عبر الإنترنت باستخدام خدمات onworks.net