fpdoc-3.0.0 - ออนไลน์ใน Cloud

โครงการ:

ชื่อ

fpdoc - ตัวสร้างเอกสารหน่วย FPC Pascal

เรื่องย่อ

เอฟพีดอค --input=inputcommand [--output=output] [--format=fmt] [--descr=descriptionfile]
[--แพ็คเกจ=ชื่อแพ็คเกจ] [ตัวเลือก]

รายละเอียด

เอฟพีดอค สแกนไฟล์ต้นทางหน่วย Free Pascal และสร้างเอกสารประกอบ NS
เอกสารสามารถอยู่ในรูปแบบต่างๆ (ปัจจุบันคือ HTML และ LaTeX) สามารถอ่านได้หลากหลาย
ไฟล์คำอธิบายที่มีคำอธิบายสัญลักษณ์ต่างๆ ที่พบในหน่วยการเรียนรู้
ไฟล์

การใช้

คุณสามารถเรียกใช้ เอฟพีดอค ด้วยอาร์กิวเมนต์ที่จำเป็นเพียงอย่างเดียวคือ 'อินพุต' และ 'แพ็คเกจ'
อาร์กิวเมนต์ อย่างน้อยควรมีชื่อไฟล์หน่วยที่เอกสารประกอบ
ควรสร้างและชื่อของแพ็คเกจที่เป็นของหน่วย

Options

เอฟพีดอค มีหลายตัวเลือก ส่วนใหญ่เป็นทางเลือก ค่าเริ่มต้นจะถูกใช้ในกรณีส่วนใหญ่

--เนื้อหา
ตัวเลือกนี้บอก เอฟพีดอค เพื่อสร้างไฟล์เนื้อหา ไฟล์เนื้อหาประกอบด้วยรายการ
ของจุดยึดที่เป็นไปได้ทั้งหมด (ป้ายกำกับ) ในไฟล์เอกสารที่สร้างขึ้น และ can
ใช้เพื่อสร้างการเชื่อมโยงข้ามในเอกสารประกอบสำหรับหน่วยต่าง ๆ โดยใช้
--นำเข้า ตัวเลือก

--cputarget=ค่า
ตัวเลือกนี้บอก เอฟพีดอค สำหรับ CPU ตัวใดที่จะสร้างเอกสาร ง่ายๆแค่นี้
กำหนดมาโคร CPU ที่เหมาะสม

--descr=descfile
ตัวเลือกนี้ระบุชื่อไฟล์คำอธิบาย ถอดรหัสไฟล์ ที่มีไฟล์
เอกสารจริงสำหรับหน่วย ตัวเลือกนี้สามารถให้ได้หลายครั้งสำหรับ
ไฟล์คำอธิบายหลายไฟล์

--descr-dir=ผบ
ตัวเลือกนี้ระบุชื่อของไดเร็กทอรีที่มีไฟล์คำอธิบาย XML ชื่อ dir
ตัวเลือกนี้สามารถกำหนดได้หลายครั้ง สำหรับไดเร็กทอรีคำอธิบายหลายไดเร็กทอรี นี้
ตัวเลือกเทียบเท่ากับการระบุไฟล์ทั้งหมดในไดเร็กทอรีด้วย --descr
ตัวเลือก

--อย่าตัดแต่ง
ตัวเลือกนี้บอก fpdoc ไม่ให้ตัดแต่งช่องว่างในไฟล์ XML โดยค่าเริ่มต้น,
ช่องว่างถูกตัดออกจากอินพุต ซึ่งสามารถมีผลข้างเคียงที่ไม่พึงประสงค์ใน
เช่น แท็ก PRE

--ดรายรัน
ตัวเลือกนี้บอก เอฟพีดอค ไม่ได้สร้างเอาต์พุตใด ๆ แต่เพียงแยกวิเคราะห์อินพุตทั้งหมด นี้
สามารถใช้กับตัวเลือก verbose เพื่อตรวจสอบว่าข้อผิดพลาดใดยังคงอยู่ใน
เอกสารหรือสิ่งที่ขาดหายไป

--รูปแบบ=fmt
ระบุรูปแบบ เอฟเอ็มที ซึ่งเอกสารจะถูกสร้างขึ้น ปัจจุบัน
รู้จักรูปแบบต่อไปนี้:

หืม CHM ที่มีชื่อไฟล์ที่สอดคล้องกับ 8.3 สำหรับ windows ส่วนใหญ่

dxml เอาต์พุต XML ที่เข้ากันได้กับ Delphi

htm HTML ที่มีชื่อไฟล์ที่สอดคล้องกับ 8.3

HTML HTML ที่มีชื่อไฟล์ยาว

IPF เอาต์พุต IPF (รูปแบบ OS/2 สามารถใช้กับ docview จาก fpGUI)

xhtml XHTML พร้อมชื่อไฟล์แบบยาว

น้ำยาง LaTex ซึ่งใช้รูปแบบ fpc.sty ที่ใช้โดยเอกสาร Free Pascal

มนุษย์ เอาต์พุต man page (หน้าคู่มือ unix หนึ่งหน้าต่อตัวระบุ)

RTF เอาต์พุต RTF

TXT เอาต์พุตข้อความธรรมดา

xml-โครงสร้าง
XML ที่มีโครงสร้าง

--ช่วยด้วย แสดงสรุปตัวเลือกบรรทัดคำสั่ง

--ซ่อน-ป้องกัน
โดยค่าเริ่มต้น เอกสารประกอบจะประกอบด้วยคำอธิบายและรายการของการป้องกัน
ฟิลด์และเมธอดในคลาสหรืออ็อบเจ็กต์ ตัวเลือกนี้จะเปลี่ยนพฤติกรรมนี้ ถ้ามัน
ระบุไว้ จะไม่มีการสร้างเอกสารสำหรับวิธีการเหล่านี้ สังเกตว่า
วิธีการสาธารณะหรือคุณสมบัติที่อ้างถึงวิธีการที่ได้รับการป้องกันเหล่านี้จะมี
ห้อยต่องแต่ง (เช่นไม่มี) ลิงค์

--html-search=ลิงค์
เพิ่มรายการสำหรับหน้าค้นหา HTML ที่ตำแหน่ง ลิงค์ ในส่วนหัวของ
สร้างหน้า HTML ไม่มีหน้าค้นหาให้ ควรทำและ
ให้โดยผู้ใช้

--import=อิมพอร์ตไฟล์
นำเข้าไฟล์เนื้อหา เปราะบาง จากเอกสารชุดอื่น สามารถใช้เพื่อ
แก้ไขการอ้างอิงถึงองค์ประกอบภายในไฟล์เอกสารอื่น ๆ นี้

--input=cmd
ตัวเลือกนี้บอก เอฟพีดอค ควรใช้ไฟล์อินพุตใด อาร์กิวเมนต์ cmd เป็นไปได้
แค่ชื่อไฟล์แต่ยังสามารถเป็นคอมไพเลอร์บรรทัดคำสั่งที่สมบูรณ์พร้อมตัวเลือกที่
เกี่ยวข้องกับการสแกนแหล่งที่มาของปาสกาล: กำหนด รวมไฟล์ ตัวเลือกไวยากรณ์
เนื่องจากจะถูกระบุให้กับคอมไพเลอร์ pascal ฟรีเมื่อทำการคอมไพล์ไฟล์ ถ้า
ใช้คำสั่งที่สมบูรณ์แล้วควรอยู่ในเครื่องหมายคำพูดเดี่ยวหรือคู่
เปลือกจะไม่แตกเป็นชิ้นๆ สามารถระบุได้หลายรายการ
คำสั่งอินพุต; พวกเขาจะได้รับการปฏิบัติทีละคนและเอกสารจะเป็น
สร้างขึ้นสำหรับแต่ละคน

--อินพุต-dir=dir
ตัวเลือกนี้บอก เอฟพีดอค เพื่อเพิ่มไฟล์ .pas และ .pp ทั้งหมดในไดเร็กทอรีชื่อ cmd as
ไฟล์อินพุตไปยังผู้จัดทำเอกสาร ซึ่งเทียบเท่ากับการระบุไฟล์ทั้งหมดในไฟล์
ไดเรกทอรีที่มี --ป้อนข้อมูล คำสั่ง

--lang=ภาษา
ตั้งค่าภาษาสำหรับไฟล์เอาต์พุต ซึ่งส่วนใหญ่จะกำหนดสตริงที่ใช้สำหรับ
ส่วนหัวในส่วนต่างๆ ของไฟล์เอกสาร (โดยค่าเริ่มต้นคือ
ภาษาอังกฤษ). ปัจจุบันตัวเลือกที่ถูกต้องคือ

de เยอรมัน.

fr ฝรั่งเศส

nl ดัตช์

--latex-extension=ต่อ
ตั้งค่านามสกุลที่จะใช้สำหรับไฟล์ LaTeX เป็น ต่อ ค่าเริ่มต้นคือ .เท็กซ์ (กับ .
(จุด) รวมอยู่ด้วย)

--ลาเท็กซ์-ไฮไลท์
เปิดเครื่องเน้นไวยากรณ์ลาเท็กซ์ภายใน นี้ยังไม่ได้ดำเนินการ โดย
ค่าเริ่มต้น การเน้นไวยากรณ์มีให้โดยแพ็คเกจไวยากรณ์ที่มาพร้อมกับ fpc

--mo-dir=ผบ
ตัวเลือกนี้บอก เอฟพีดอค จะหาไฟล์แปลที่ใช้งานได้ที่ไหน
ทำให้การส่งออกของ fpdoc เป็นสากล

--ostarget=ค่า
ตัวเลือกนี้บอก เอฟพีดอค สำหรับระบบปฏิบัติการใดในการสร้างเอกสาร นี้
เพียงแค่กำหนดมาโครระบบปฏิบัติการที่เหมาะสม

--output=ชื่อ
ตัวเลือกนี้บอก เอฟพีดอค ที่ซึ่งไฟล์เอาต์พุตควรถูกสร้างขึ้น วิธีตัวเลือกนี้
จะถูกตีความขึ้นอยู่กับรูปแบบที่ใช้ สำหรับน้ำยางข้น ชื่อ ถูกตีความ
เป็นชื่อไฟล์สำหรับไฟล์ tex สำหรับรูปแบบอื่นๆ ทั้งหมด ชื่อ ถูกตีความว่าเป็น
ไดเร็กทอรีที่จะเขียนไฟล์เอกสารทั้งหมด ไดเร็กทอรีจะเป็น
สร้างขึ้นถ้ายังไม่มี มาตรฐานนี้เท่ากับชื่อแพ็คเกจ

--package=ชื่อแพ็คเกจ
ระบุชื่อแพ็คเกจ หน่วยทั้งหมดจะได้รับการบันทึกไว้เป็นส่วนหนึ่งของ ชื่อแพ็คเกจ ,
ซึ่งเป็นชื่อไฟล์เอาต์พุตหรือไดเร็กทอรีเริ่มต้น โหนดเอกสารเท่านั้น
ภายในโหนดแพ็คเกจที่มีชื่อนี้จะได้รับการพิจารณาเมื่อทำการจัดทำเอกสาร

--parse-นัย
(ทดลอง) พยายามแยกวิเคราะห์การดำเนินการของหน่วยด้วย สามารถใช้สำหรับ
การตรวจสอบไวยากรณ์

--project=ไฟล์
ตัวเลือกนี้บอก เอฟพีดอค เพื่ออ่านตัวเลือกทั้งหมดจากไฟล์โครงการ นี่คือ XML
โปรดดูเอกสารสำหรับข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบนี้
ไฟล์

--show-ส่วนตัว
ตามค่าเริ่มต้น จะไม่มีการสร้างเอกสารสำหรับเมธอดหรือฟิลด์ส่วนตัว นี้
สาเหตุทางเลือก เอฟพีดอค เพื่อสร้างเอกสารสำหรับวิธีการเหล่านี้ด้วย

--รายละเอียด
โดยค่าเริ่มต้น เอฟพีดอค มีน้อยด้วยการส่งออก สิ่งนี้บอกให้ fpdoc สร้างเพิ่มเติม
ข้อมูลเกี่ยวกับสิ่งที่ทำ

--warn-no-โหนด
หากระบุตัวเลือกนี้ เอฟพีดอค จะส่งคำเตือนหากไม่พบ
โหนดคำอธิบายสำหรับตัวระบุที่เป็นเอกสาร

--write-project = ไฟล์
หากระบุตัวเลือกนี้ เอฟพีดอค จะเขียนไฟล์โครงการ fpdoc (ไปที่
ชื่อไฟล์ที่ระบุ) ที่สอดคล้องกับตัวเลือกบรรทัดคำสั่งที่กำหนด

ใช้ fpdoc-3.0.0 ออนไลน์โดยใช้บริการ onworks.net