Nhận xét PHP, Bao gồm/Bao gồm_một lần, Yêu cầu/Yêu cầu_một lần

Tại sao nên sử dụng Bình luận?

• Nếu bạn không làm việc với mã nguồn trong một thời gian, rất dễ quên mất chức năng của đoạn mã đó. Việc chú thích mã nguồn giúp bạn nhớ lại chức năng của nó.
• Việc bình luận mã nguồn cũng rất quan trọng khi nhiều nhà phát triển phải làm việc trên cùng một dự án. Những thay đổi được thực hiện bởi một nhà phát triển có thể được các nhà phát triển khác dễ dàng hiểu được bằng cách đọc các nhận xét.
• Theo kinh nghiệm tốt nhất, bạn nên có 3 dòng chú thích cho mỗi 10 dòng mã.

Bình luận PHP

• Nhận xét giúp chúng tôi hiểu mã
• Nhận xét là những giải thích mà chúng tôi đưa vào mã nguồn của mình. Những bình luận này là dành cho sự hiểu biết của con người.
• Các bình luận một dòng bắt đầu bằng hai dấu gạch chéo // và kết thúc trên cùng một dòng.
• 
• Nhận xét nhiều dòng bắt đầu bằng dấu gạch chéo lên, theo sau là dấu hoa thị /* và kết thúc bằng dấu hoa thị, theo sau là dấu gạch chéo lên phía trước */.
• 

Sơ đồ bên dưới hiển thị một tệp PHP có cả chú thích nhiều dòng và chú thích một dòng.

Ví dụ về PHP

Bao gồm PHP & Bao gồm PHP_once

Câu lệnh “include” trong PHP được sử dụng để bao gồm các tệp khác vào một tệp PHP.

Nó có hai biến thể, include và include_once. include_once sẽ bị trình thông dịch PHP bỏ qua nếu tệp cần bao gồm đã được bao gồm trước đó.

Câu lệnh include có cú pháp như sau

<?php
include 'file_name';
?>

Câu lệnh include_once có cú pháp sau

<?php
include_once 'file_name';
?>

ĐÂY,

• “include/include_once” là câu lệnh dùng để bao gồm tệp.
• “'file_name'” là tên của tập tin cần được bao gồm.

Ví dụ: Include / Include_once

Giả sử bạn đang phát triển...ping Một trang web có cùng một menu điều hướng trên tất cả các trang.

Bạn có thể tạo một tiêu đề chung, sau đó chèn nó vào mọi trang bằng câu lệnh include. Hãy cùng xem cách thực hiện điều này.

• Chúng ta sẽ tạo 2 tập tin có tên là
• tiêu đề.php, index.php

Dưới đây là đoạn mã cho 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';

?>

Trang tiêu đề phía trên sẽ hiển thị các liên kết điều hướng.

Yêu cầu PHP & PHP require_once

Câu lệnh require có hai biến thể, require và require_once.

Câu lệnh require/require_once được sử dụng để bao gồm một tệp.

Tham số `require_once` sẽ bị bỏ qua nếu tệp cần thiết đã được thêm vào bằng bất kỳ câu lệnh `include` nào trong bốn câu lệnh trên.

Nó có cú pháp sau

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ĐÂY,

• “require/require_once” là câu lệnh bao gồm tệp tin.
• “'file_name'” là tên của tập tin cần được bao gồm.

Ví dụ: Yêu cầu

Giả sử chúng ta đang phát triểnping Một ứng dụng dựa trên cơ sở dữ liệu.

Chúng ta có thể tạo một tệp cấu hình mà chúng ta có thể đưa vào tất cả các trang kết nối với cơ sở dữ liệu bằng cách sử dụng câu lệnh require. config.php

<?php

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

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

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

$config['password'] = '';

?>

Bây giờ chúng ta hãy xem đoạn mã ví dụ yêu cầu tệp cấu hình. Trang_model.php

<?php

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

//other code for connecting to the database

?>

PHP bao gồm và yêu cầu

Sự khác biệt giữa include và require được thể hiện bên dưới.

Thông thường, nên sử dụng câu lệnh include để khi xảy ra lỗi, quá trình thực thi tập lệnh vẫn tiếp tục và hiển thị địa chỉ email của quản trị viên web hoặc trang liên hệ.

Nên sử dụng câu lệnh require nếu toàn bộ tập lệnh không thể chạy nếu không có tệp được yêu cầu.

Bạn có thể sử dụng các câu lệnh “include” và “require” ở bất kỳ dòng nào trong mã nguồn mà bạn muốn đoạn mã đó xuất hiện.

Chú thích tài liệu PHP (PHPDoc)

Ngoài các bình luận một dòng và nhiều dòng, các nhà phát triển PHP sử dụng bình luận khối PHPDoc để ghi chú các hàm và lớp. Một khối PHPDoc bắt đầu bằng /** và sử dụng các thẻ như @param và @return mà IDE đọc để hiển thị gợi ý và tự động hoàn thành.

<?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 không làm thay đổi cách mã hoạt động, nhưng nó làm rõ mục đích của từng hàm và cho phép các công cụ tự động tạo tài liệu API. Việc thêm nó vào các tệp dùng chung, chẳng hạn như các tệp cấu hình và tệp trợ giúp ở trên, giúp duy trì tính dễ bảo trì của một codebase đang phát triển.

Câu Hỏi Thường Gặp