อ่าน 1 นาที
PHPDoc
PHPDoc เป็นการดัดแปลง รูปแบบ Javadoc สำหรับ ภาษาการเขียนโปรแกรม PHP ถึงแม้จะเป็นมาตรฐานที่ไม่เป็นทางการสำหรับ การใส่คำอธิบาย ประกอบโค้ด PHP แต่ก็อยู่ในกระบวนการทำให้เป็นทางการ [ 1...
PHPDoc
PHPDocเป็นการดัดแปลง รูปแบบ JavadocสำหรับภาษาการเขียนโปรแกรมPHP ถึงแม้จะเป็นมาตรฐานที่ไม่เป็นทางการสำหรับการใส่คำอธิบายประกอบโค้ด PHP แต่ก็อยู่ในกระบวนการทำให้เป็นทางการ[ 1 ]โดยอนุญาตให้โปรแกรมสร้างเอกสารภายนอก เช่นphpDocumentorซึ่งเป็นมาตรฐานการใช้งานโดยพฤตินัย[ 1 ]สร้างเอกสารประกอบได้ และยังช่วยให้IDE บางตัว เช่นZend Studio , NetBeans , JetBrains PhpStorm , ActiveState Komodo Edit และ IDE , PHPEditและAptana Studioสามารถตีความประเภทตัวแปรและความกำกวมอื่นๆ ในภาษาที่มีการกำหนดประเภทแบบหลวมๆและให้การเติมโค้ดอัตโนมัติ การระบุประเภท และการดีบัก ที่ดีขึ้น
PHPDoc รองรับการสร้างเอกสารสำหรับทั้งโค้ดเชิงวัตถุและโค้ด เชิงขั้นตอน
เมื่อวันที่ 13 สิงหาคม พ.ศ. 2556 กลุ่มการทำงานร่วมกันของเฟรมเวิร์ก PHP ได้เริ่มเขียนข้อกำหนดอย่างเป็นทางการ (PSR) สำหรับ PHPDoc [ 1 ]
ตัวอย่าง
/** * รับโหนดรูปภาพทั้งหมด* * @param \DOMNode $node อินสแตนซ์ \DOMNode * @param boolean $strict ว่าเอกสารต้องเป็นเอกสารที่ถูกต้องหรือไม่* * @return \DOMNode */ public function getImageNodes ( \DOMNode $node , $strict = true ) : \DOMNode { // ... }ดูเพิ่มเติม
ลิงก์ภายนอก
- phpDocumentor.org
สรุปเนื้อหา
ข้อมูลสำคัญจากบทความ
ข้อมูลสำคัญเกี่ยวกับ PHPDoc
PHPDoc เป็นการดัดแปลง รูปแบบ Javadoc สำหรับ ภาษาการเขียนโปรแกรม PHP ถึงแม้จะเป็นมาตรฐานที่ไม่เป็นทางการสำหรับ การใส่คำอธิบาย ประกอบโค้ด PHP แต่ก็อยู่ในกระบวนการทำให้เป็นทางการ [ 1...
ตัวอย่าง
/** * รับโหนดรูปภาพทั้งหมด * * @param \DOMNode $node อินสแตนซ์ \DOMNode * @param boolean $strict ว่าเอกสารต้องเป็นเอกสารที่ถูกต้องหรือไม่ * * @return \DOMNode */ public function getImageNodes ( \DOMNode $node , $strict = true ) : \DOMNode { // ... }
ดูเพิ่มเติม
phpDocumentor ด็อกซีเจน การเปรียบเทียบโปรแกรมสร้างเอกสาร
ลิงก์ภายนอก
phpDocumentor.org ดึงข้อมูลมาจาก " https://en.wikipedia.org/w/index.php?title=PHPDoc&oldid=1303148246 "