ดาวน์โหลด phpDocumentor - ดาวน์โหลดซอร์สโค้ด phpDocumentor

phpDocumentor

หมวดหมู่อื่นๆ

v3.5.3

ดาวน์โหลด

phpDocumentor.php

phpDocumentor คืออะไร?

phpDocumentor ย่อมาจากเครื่องมือเอกสารประกอบสำหรับโครงการ PHP โดยนำเสนอโซลูชันที่มีประสิทธิภาพสำหรับการสร้างเอกสารที่ครอบคลุมได้อย่างง่ายดาย ด้วยการวิเคราะห์ซอร์สโค้ด PHP และความคิดเห็น DocBlock phpDocumentor จะสร้างชุดเอกสาร API ที่สมบูรณ์ ทำให้เป็นเครื่องมือที่ขาดไม่ได้สำหรับนักพัฒนาที่มุ่งมั่นในการสร้างฐานโค้ดที่ชัดเจนและมีการจัดทำเอกสารไว้อย่างดี

นอกเหนือจากความเก่งกาจในเอกสาร API แล้ว phpDocumentor ยังก้าวไปอีกขั้นด้วยการมอบคุณสมบัติเพิ่มเติม มีความสามารถในการสร้างไดอะแกรม UML ทำให้เป็นเครื่องมืออเนกประสงค์สำหรับการแสดงโครงสร้างโค้ดเป็นภาพ นอกจากนี้ phpDocumentor ยังมีตัวแยกวิเคราะห์ภาษามาร์กอัปที่มีคุณสมบัติครบถ้วน ซึ่งรองรับทั้งไวยากรณ์ RestructuredText และ Markdown ความยืดหยุ่นนี้ทำให้คุณสามารถจัดทำเอกสารโครงการของคุณโดยใช้ภาษามาร์กอัปที่เหมาะกับความต้องการของคุณมากที่สุด

คุณลักษณะเด่นของ phpDocumentor คือความสามารถในการรวมส่วนต่างๆ ของเอกสาร API ของคุณลงในเอกสาร RestructuredText ของคุณโดยตรง การผสานรวมนี้ช่วยให้แน่ใจว่าเอกสารและรหัสของคุณยังคงซิงค์กัน ซึ่งช่วยคุณประหยัดเวลาและความพยายามในการรักษาเอกสารประกอบโครงการที่ถูกต้องและทันสมัย

ได้รับแรงบันดาลใจจาก phpDocumentor 1 และ JavaDoc รุ่นก่อน ทำให้ phpDocumentor ยังคงสร้างสรรค์สิ่งใหม่ๆ อย่างต่อเนื่อง โดยคอยติดตามเทคโนโลยีล่าสุดและฟีเจอร์ภาษา PHP ความมุ่งมั่นนี้ทำให้มั่นใจได้ว่านักพัฒนาจะสามารถเข้าถึงประสบการณ์ด้านเอกสารที่ดีที่สุดเท่าที่จะเป็นไปได้ ซึ่งสอดคล้องกับแนวทางการพัฒนาสมัยใหม่

ในคู่มือนี้ เราจะสำรวจคุณสมบัติต่างๆ ของ phpDocumentor ตั้งแต่ฟังก์ชันหลักในการสร้างเอกสาร API ไปจนถึงความสามารถขั้นสูงในการแยกวิเคราะห์ภาษามาร์กอัป ไม่ว่าคุณจะเป็นมือใหม่หรือนักพัฒนาที่มีประสบการณ์ phpDocumentor คือพันธมิตรของคุณในการสร้างโปรเจ็กต์ PHP ที่มีการจัดทำเอกสารอย่างดี บำรุงรักษาได้ และเข้าใจได้

phpDocumentor v3 (เสถียร)

v3 เป็นเวอร์ชันเสถียรล่าสุด

เอกสารประกอบ

สำหรับข้อมูลโดยละเอียดเพิ่มเติม คุณสามารถตรวจสอบเอกสารออนไลน์ของเราได้ที่ https://docs.phpdoc.org/

คุณสมบัติ

phpDocumentor รองรับสิ่งต่อไปนี้:

รองรับ PHP 7.0+ รองรับเนมสเปซ การปิด และอื่นๆ อย่างเต็มที่
Docblock over types , docblocks อาจมีความชัดเจนมากขึ้นเกี่ยวกับประเภท php ดั้งเดิมไม่รองรับทุกรูปแบบ
แสดงแท็กใดๆ บางแท็กเพิ่มฟังก์ชันการทำงานเพิ่มเติมให้กับ phpDocumentor (เช่น @link)
การใช้หน่วยความจำต่ำ การใช้หน่วยความจำสูงสุดสำหรับโปรเจ็กต์ขนาดเล็กน้อยกว่า 20MB โปรเจ็กต์ขนาดกลาง 40MB และเฟรมเวิร์กขนาดใหญ่ 100MB
การแยกวิเคราะห์ส่วนเพิ่ม หากคุณเก็บไฟล์โครงสร้างไว้จากการเรียกใช้ครั้งก่อน คุณจะได้รับการเพิ่มประสิทธิภาพเพิ่มเติมสูงสุดถึง 80% นอกเหนือจากความเร็วการประมวลผลที่เพิ่มขึ้นข้างต้น
การสร้างเทมเพลตอย่างง่าย หากคุณต้องการสร้างแบรนด์ คุณจะต้องเรียกใช้ 1 งานและแก้ไข 3 ไฟล์
กระบวนการสองขั้นตอน phpDocumentor จะสร้างแคชด้วยโครงสร้างแอปพลิเคชันของคุณก่อนก่อนที่จะสร้างเอาต์พุต หากคุณต้องการ คุณสามารถใช้สิ่งนั้นเพื่อขับเคลื่อนเครื่องมือหรือฟอร์แมตเตอร์ของคุณเองได้!
การสนับสนุนทั่วไป ด้วยการวิเคราะห์แบบคงที่มากขึ้นในประเภท php มีความซับซ้อนมากขึ้น phpDocumentor เข้าใจประเภทเหล่านี้ และจะทำให้พวกมันเป็นประเภทเฟิร์สคลาส

การติดตั้ง

PhpDocumentor ต้องใช้ PHP 8.1 หรือสูงกว่าจึงจะทำงานได้ อย่างไรก็ตาม สามารถวิเคราะห์โค้ดของ PHP เวอร์ชันก่อนหน้าได้

เทมเพลตทั้งหมดที่มาพร้อมกับ phpDocumentor รองรับไดอะแกรมคลาสตามฐานโค้ดการอ่าน สิ่งนี้จะต้องติดตั้งแอปพลิเคชัน [PlantUml] บนเครื่องที่ใช้งาน phpDocumentor การเรนเดอร์ไดอะแกรมคลาสโดยใช้ [PlantUml] เป็นทางเลือก และสามารถละเว้นคำเตือนเกี่ยวกับ [PlantUml] ที่หายไปได้ อย่างไรก็ตาม เอกสารของคุณจะมีลิงก์ที่ใช้งานไม่ได้ในกรณีนี้ แผนภาพคลาสจะถูกสร้างขึ้นด้วยตัวเลือก --setting=graphs.enabled=true

มี 4 วิธีในการติดตั้ง phpDocumentor:

การใช้ phive (แนะนำ)
การใช้ PHAR (การติดตั้งด้วยตนเอง)
ผ่านทางนักเทียบท่า
ผ่านทางผู้แต่ง

การใช้ไฟฟ์

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ phive โปรดดูที่เว็บไซต์ของพวกเขา ตอนนี้คุณได้ติดตั้ง phpDocumentor แล้ว ซึ่งสามารถดำเนินการได้ดังนี้:

php tools/phpDocumentor

การใช้ PHAR

ดาวน์โหลดไฟล์ phar จาก https://github.com/phpDocumentor/phpDocumentor/releases
คุณสามารถดำเนินการ phar ได้ดังนี้: php phpDocumentor.phar

ผ่านทางนักเทียบท่า

$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

ผ่าน Composer (ไม่แนะนำ)

แต่เดี๋ยวก่อน? แล้วนักแต่งเพลงล่ะ?

อา คุณค้นพบความลับของเราแล้ว มีแพ็คเกจผู้แต่ง phpdocumentor ที่คุณสามารถใช้เพื่อติดตั้ง phpDocumentor

อย่างไรก็ตาม: phpDocumentor เป็นแอปพลิเคชันที่ซับซ้อน และไลบรารีของมันถูกใช้ในไลบรารีและแอปพลิเคชันอื่นๆ นับไม่ถ้วน (ไลบรารี 2 แห่งของเรามีการดาวน์โหลดมากกว่า 150 ล้านครั้งในแต่ละครั้ง) และนั่นหมายความว่าโอกาสที่จะเกิดข้อขัดแย้งระหว่างหนึ่งในผู้พึ่งพาของเราและของคุณนั้นมีสูง แล้วพอบอกว่าสูงก็สูงจริงๆ

ด้วยเหตุนี้ เราไม่รับรองหรือสนับสนุนการติดตั้ง phpDocumentor โดยใช้ Composer

วิธีการใช้งาน phpDocumentor

วิธีที่ง่ายที่สุดในการรัน phpDocumentor คือการรันคำสั่งต่อไปนี้:

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

คำสั่งนี้จะแยกวิเคราะห์ซอร์สโค้ดที่ระบุโดยใช้อาร์กิวเมนต์ -d และส่งออกไปยังโฟลเดอร์ที่ระบุโดยอาร์กิวเมนต์ -t

phpDocumentor รองรับตัวเลือกมากมายเพื่อกำหนดค่าเอาต์พุตของเอกสารของคุณ คุณสามารถดำเนินการคำสั่งต่อไปนี้ หรือตรวจสอบเว็บไซต์ของเรา เพื่อดูรายการตัวเลือกบรรทัดคำสั่งที่มีรายละเอียดเพิ่มเติม

$ phpdoc run -h

ไฟล์การกำหนดค่า

phpDocumentor ยังรองรับการใช้ไฟล์การกำหนดค่า (ชื่อ phpdoc.xml หรือ phpdoc.dist.xml ตามค่าเริ่มต้น) โปรดอ่านเอกสารประกอบเพื่อดูรูปแบบและตัวเลือกที่รองรับ

สร้างทุกคืน

PhpDocumentor ไม่มีการเผยแพร่ทุกคืน อย่างไรก็ตาม ในระหว่างไปป์ไลน์แต่ละท่อ สิ่งประดิษฐ์ฟาร์จะถูกสร้างขึ้น หากคุณต้องการทดสอบ phpDocumentor เวอร์ชัน Bleeding Edge โปรดดูในส่วนการดำเนินการของที่เก็บนี้ แต่ละเวิร์กโฟลว์ QA ที่ประสบความสำเร็จมีส่วนส่วนสิ่งประดิษฐ์ที่ด้านล่างพร้อมกับสร้างส่วน phar