ความคิดเห็น PHP, รวม/Include_once, ต้องการ/Require_once

เหตุใดจึงต้องใช้ความคิดเห็น?

• หากคุณไม่ได้ทำงานกับโค้ดต้นฉบับเป็นเวลานาน คุณอาจลืมไปได้ง่ายๆ ว่าโค้ดนั้นทำอะไร การใส่คำอธิบายประกอบในโค้ดต้นฉบับจะช่วยให้คุณจำได้ว่าโค้ดนั้นทำอะไร
• การแสดงความคิดเห็นซอร์สโค้ดก็มีความสำคัญเช่นกัน เมื่อนักพัฒนาหลายคนต้องทำงานในโครงการเดียวกัน การเปลี่ยนแปลงที่ทำโดยนักพัฒนารายหนึ่งสามารถเข้าใจได้ง่ายโดยนักพัฒนารายอื่นเพียงแค่อ่านความคิดเห็น
• ตามหลักปฏิบัติที่ดี คุณควรมีคำอธิบายประกอบ 3 บรรทัดต่อโค้ดทุกๆ 10 บรรทัด

ความคิดเห็น PHP

• ความคิดเห็นช่วยให้เราเข้าใจโค้ด
• ความคิดเห็นคือคำอธิบายที่เรารวมไว้ในซอร์สโค้ดของเรา ความคิดเห็นเหล่านี้มีไว้เพื่อความเข้าใจของมนุษย์
• ข้อความแสดงความคิดเห็นแบบบรรทัดเดียวจะเริ่มต้นด้วยเครื่องหมายทับคู่ // และจะจบลงในบรรทัดเดียวกัน
• 
• ความคิดเห็นหลายบรรทัดเริ่มต้นด้วยเครื่องหมายทับตามด้วยเครื่องหมายดอกจัน /* และสิ้นสุดด้วยเครื่องหมายดอกจันตามด้วยเครื่องหมายทับ */
• 

แผนภาพด้านล่างแสดงไฟล์ PHP ที่มีทั้งคอมเมนต์แบบหลายบรรทัดและแบบบรรทัดเดียว

ตัวอย่าง PHP

PHP รวม & PHP รวม_ครั้งเดียว

คำสั่ง “include” ใน PHP ใช้สำหรับรวมไฟล์อื่น ๆ เข้ามาในไฟล์ PHP ไฟล์เดียว

คำสั่งนี้มีสองรูปแบบ คือ include และ include_once โดย include_once จะถูกละเว้นโดยตัวแปลภาษา PHP หากไฟล์ที่จะรวมนั้นได้ถูกรวมไว้แล้ว

คำสั่ง include มีรูปแบบต่อไปนี้

<?php
include 'file_name';
?>

คำสั่ง include_once มีรูปแบบดังต่อไปนี้

<?php
include_once 'file_name';
?>

ที่นี่

• “include/include_once” คือคำสั่งที่ใช้ในการรวมไฟล์
• “'file_name'” คือชื่อของไฟล์ที่จะนำมารวมไว้

ตัวอย่าง: Include / Include_once

สมมติว่าคุณกำลังพัฒนา...ping เว็บไซต์ที่มีเมนูนำทางเดียวกันในทุกหน้า

คุณสามารถสร้างส่วนหัวทั่วไป จากนั้นรวมส่วนหัวนั้นในทุกหน้าโดยใช้คำสั่ง include มาดูกันว่าทำได้อย่างไร

• เราจะสร้างไฟล์ 2 ไฟล์ โดยตั้งชื่อว่า...
• header.php, ดัชนี.php

ด้านล่างนี้คือโค้ดสำหรับ header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

ส่วนหัวของหน้าเว็บด้านบนจะแสดงลิงก์นำทาง

PHP ต้องการ & PHP need_once

คำสั่ง need มีสองรูปแบบ คือ need และ need_once

คำสั่ง require/require_once ใช้สำหรับเรียกไฟล์เข้ามา

คำสั่ง `require_once` จะถูกละเว้นหากไฟล์ที่ต้องการได้ถูกเพิ่มเข้าไปแล้วโดยคำสั่ง `include` ใดๆ ในสี่คำสั่งนั้น

มีรูปแบบประโยคดังนี้

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ที่นี่

• “require/require_once” คือคำสั่งที่รวมไฟล์เข้ามา
• “'file_name'” คือชื่อของไฟล์ที่จะนำมารวมไว้

ตัวอย่าง: ต้องใช้

สมมติว่าเรากำลังพัฒนา...ping แอปพลิเคชันที่ขับเคลื่อนด้วยฐานข้อมูล

เราสามารถสร้างไฟล์คอนฟิกูเรชันที่เราสามารถรวมไว้ในเพจทั้งหมดที่เชื่อมต่อกับฐานข้อมูลโดยใช้คำสั่ง need config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

ต่อไปนี้เราจะมาดูตัวอย่างโค้ดที่ต้องใช้ไฟล์การกำหนดค่ากัน Pages_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP รวมและต้องการ

ความแตกต่างระหว่าง include และ require แสดงไว้ด้านล่าง

โดยทั่วไป แนะนำให้ใช้คำสั่ง include เพื่อให้เมื่อเกิดข้อผิดพลาด สคริปต์จะยังคงทำงานต่อไปและแสดงที่อยู่อีเมลของเว็บมาสเตอร์หรือหน้าติดต่อเราได้

ควรใช้คำสั่ง need หากสคริปต์ทั้งหมดไม่สามารถทำงานได้หากไม่มีไฟล์ที่ร้องขอ

คำสั่ง “include” และ “require” สามารถใช้ได้ในบรรทัดใดก็ได้ในซอร์สโค้ดที่คุณต้องการให้โค้ดนั้นปรากฏ

คำอธิบายประกอบเอกสาร PHP (PHPDoc)

นอกเหนือจากการใช้คอมเมนต์แบบบรรทัดเดียวและหลายบรรทัดแล้ว นักพัฒนา PHP ยังใช้บล็อกคอมเมนต์ PHPDoc เพื่ออธิบายฟังก์ชันและคลาสต่างๆ บล็อก PHPDoc เริ่มต้นด้วย /** และใช้แท็กต่างๆ เช่น @param และ @return ซึ่ง IDE จะอ่านเพื่อแสดงคำแนะนำและฟังก์ชันเติมข้อความอัตโนมัติ

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

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

คำถามที่พบบ่อย