Làm cách nào để nhận xét một khối mã php?

Nhận xét là phần quan trọng của mã. Nhận xét cung cấp thông tin hữu ích sẽ giúp bạn và các nhà phát triển khác hiểu ý nghĩa của mã nhanh hơn sau này

PHP hỗ trợ hai loại nhận xét

• Bình luận một dòng
• Nhận xét nhiều dòng

Bình luận một dòng

Chú thích một dòng được đặt ở cuối dòng hoặc ở khối hiện tại

Nhận xét một dòng bắt đầu bằng dấu thăng (_______10_______) hoặc dấu gạch chéo kép (//). Phần còn lại của văn bản sau dấu (//) bị trình thông dịch PHP bỏ qua

Ví dụ sau sử dụng // cho chú thích một dòng

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // payout calculation
Code language: HTML, XML (xml)

Và ví dụ sau sử dụng dấu # cho chú thích một dòng

$title = 'PHP comment'; # set default title
Code language: HTML, XML (xml)

Nhận xét nhiều dòng

Nhận xét nhiều dòng bắt đầu bằng /* và kết thúc bằng */. Ví dụ

/*
   This is an example of a multi-line comment,
   which can span multiple lines.
*/



Code language: HTML, XML (xml)

Trong thực tế, bạn sử dụng chú thích nhiều dòng khi bạn cần kéo dài chú thích nhiều dòng

Viết bình luận có ý nghĩa

Để ghi lại mã của bạn một cách hiệu quả, bạn sử dụng các nguyên tắc sau

1) Làm cho mã tự nói mà không cần sử dụng nhận xét bằng cách đặt tên cho các mã định danh có ý nghĩa. Ví dụ: bạn có thể sử dụng như sau

Một số người có thể lập luận rằng không có bình luận, các nhà phát triển và lập trình viên sẽ có thể tìm ra ý định của mã bằng cách nhìn vào nó

Mặc dù điều này là đúng, nhưng việc tìm ra mã mà bạn không tự viết có thể có ý nghĩa mơ hồ

Bằng cách thêm nhận xét, bạn sẽ loại bỏ mọi nghi ngờ về mục đích của mã, cho phép những người khác làm việc hiệu quả hơn

Nhận xét cũng được sử dụng để xóa các phần mã của bạn khỏi quá trình thực thi. Điều này cho phép bạn gỡ lỗi mã của mình mà không phải xóa mã đó khỏi tệp

Có hai cách khác nhau để viết bình luận trong PHP

• Nhận xét một dòng
• Nhận xét nhiều dòng

Hãy xem cách bạn có thể làm cả hai trong hướng dẫn này

Tạo bình luận một dòng PHP

Để tạo nhận xét một dòng trong PHP, bạn cần thêm ký hiệu dấu gạch chéo kép (//) hoặc dấu thăng (_______10_______) vào mã của mình

Hãy xem xét ví dụ dưới đây

php
echo "Hello World!";
// This is a comment
# This is also a comment

Biểu tượng nhận xét sẽ chỉ đánh dấu tất cả văn bản ở bên phải biểu tượng

Bạn có thể thêm mã ở phía bên trái của nhận xét

php
echo "Hello World!"; // Right-side comment

echo "Good morning"; # Also a right-side comment

Bạn có thể nhận xét một mã để loại trừ nó chạy như thế này

// echo "Hello World!"; // Right-side comment

echo "Good morning";

Hàm echo đầu tiên ở trên được nhận xét, vì vậy, Hello World! sẽ không được in vào lần tiếp theo trình biên dịch PHP xử lý mã

Và đó là cách bạn tạo nhận xét một dòng. Tiếp theo hãy xem cách tạo bình luận nhiều dòng

Nhận xét nhiều dòng PHP

Để tạo một bình luận nhiều dòng trong PHP, bạn cần phải

1. Mở nhận xét bằng ký hiệu dấu gạch chéo và dấu hoa thị (/*)
2. Đóng nhận xét bằng dấu hoa thị và dấu gạch chéo lên (

   php
   echo "Hello World!"; // Right-side comment
   
   echo "Good morning"; # Also a right-side comment
   

   0)

Đây là một ví dụ về việc tạo bình luận nhiều dòng

php
/* This is a multi-line PHP comment
The comment will continue
as long as you do not close it. */

echo "Hello World!";
?>

Có ba dòng bình luận trong ví dụ trên

PHP cũng có một phần mở rộng gọi là PHPDoc giúp tăng tính hữu ích của một bình luận

Ví dụ: bạn có thể mô tả các tham số được sử dụng trong một hàm bằng cách sử dụng thẻ

php
echo "Hello World!"; // Right-side comment

echo "Good morning"; # Also a right-side comment

php
/**
 * Print greetings.
 *
 * @param string  $name     The name to greet.
 * @param string  $greeting The greeting to print
 *                           Defaults to `Hello`.
 */
function greetings(string $name, string $greeting = "Hello")
{
    echo "$greeting, $name!";
}

Định dạng PHPDoc như hình trên sẽ được chọn bởi PHP IDE hiện đại, cho phép bạn xem nguồn mã khi bạn di chuột qua cú pháp gọi

Gợi ý nhận xét PHP được chọn bởi IDE

Như bạn có thể thấy, nhận xét rất hữu ích để xác minh mục đích mã của bạn

Các mô tả chi tiết, dài dòng sử dụng định dạng PHPDoc cũng cho phép PHP IDE cung cấp gợi ý mã và tự động hoàn thành

Khi bạn làm việc trong các dự án dài hạn, việc thêm nhận xét sẽ đẩy nhanh tiến độ của bạn và giúp những người khác làm việc hiệu quả hơn

Làm cách nào để nhận xét nhiều dòng mã trong PHP?

Phím tắt để bình luận trong PHP là gì?

Đó là cách chính xác để bắt đầu một nhận xét PHP nhiều dòng?