Làm cách nào để bạn đưa ra các nhận xét trong php?

Trong bài viết này, chúng ta phải truyền nhận xét cho mã PHP bằng cách sử dụng một số cú pháp cơ bản đơn giản. Nhận xét rất hữu ích để hiểu mã phức tạp. Thẻ nhận xét hữu ích trong quá trình gỡ lỗi mã. Chúng tôi sử dụng nhận xét để hiểu chức năng của mã.  

Khi viết một tập lệnh dài, sẽ rất hữu ích bằng cách thêm nhận xét vào mỗi bước về chức năng của mã

Nếu một số người khác sử dụng mã của bạn hoặc cập nhật thì người dùng sẽ dễ hiểu hoạt động của mã hơn và tiết kiệm thời gian

Chú thích trong PHP tương tự như chú thích được sử dụng trong HTML. Cú pháp bình luận PHP luôn bắt đầu bằng một chuỗi ký tự đặc biệt và tất cả văn bản xuất hiện từ đầu đến cuối bình luận sẽ bị bỏ qua

Trong HTML, mục đích chính của nhận xét là dùng làm ghi chú cho bạn, nhà phát triển web hoặc cho những người khác có thể xem mã nguồn trang web của bạn. Tuy nhiên, các bình luận của PHP khác ở chỗ chúng sẽ không được hiển thị cho khách truy cập của bạn. Cách duy nhất để xem bình luận PHP là mở tệp PHP để chỉnh sửa. Điều này làm cho các nhận xét PHP chỉ hữu ích cho các lập trình viên PHP

Trong trường hợp bạn quên bình luận HTML trông như thế nào, hãy xem ví dụ của chúng tôi bên dưới

Mã HTML

Trong khi chỉ có một loại bình luận trong HTML, PHP có hai loại. Loại đầu tiên chúng ta sẽ thảo luận là chú thích một dòng. Nhận xét một dòng yêu cầu trình thông dịch bỏ qua mọi thứ xảy ra trên dòng đó ở bên phải nhận xét. Để thực hiện một dòng nhận xét, hãy nhập "//" hoặc "#" và tất cả văn bản ở bên phải sẽ bị trình thông dịch PHP bỏ qua

Mã PHP

Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>

Trưng bày

Xin chào thế giới.
Psst. Bạn không thể nhìn thấy bình luận PHP của tôi.

Lưu ý rằng một vài câu lệnh echo của chúng tôi không được đánh giá vì chúng tôi đã nhận xét chúng bằng nhận xét một dòng. Loại chú thích dòng này thường được sử dụng để ghi chú nhanh về mã phức tạp và khó hiểu hoặc để xóa tạm thời một dòng mã PHP

Tương tự như chú thích HTML, chú thích PHP nhiều dòng có thể được sử dụng để chú thích các khối mã lớn hoặc viết chú thích nhiều dòng. Nhận xét PHP nhiều dòng bắt đầu bằng " /* " và kết thúc bằng " */ "

Mã PHP

Trưng bày

Một trong những phương pháp bình luận tốt nhất mà tôi có thể giới thiệu cho các lập trình viên PHP mới là. SỬ DỤNG CHÚNG. Vì vậy, nhiều người viết mã PHP phức tạp và quá lười biếng để viết bình luận hay hoặc tin rằng bình luận là không cần thiết. Tuy nhiên, bạn có thực sự tin rằng bạn sẽ nhớ chính xác những gì bạn đã nghĩ khi nhìn vào đoạn mã này sau một năm hoặc lâu hơn không?

Hãy để các nhận xét thấm vào mã của bạn và bạn sẽ trở thành một PHPer hạnh phúc hơn trong tương lai. Sử dụng chú thích một dòng để ghi chú nhanh về một phần phức tạp trong mã của bạn và sử dụng chú thích nhiều dòng khi bạn cần mô tả điều gì đó sâu hơn một chú thích đơn giản

Nếu bạn muốn tải xuống bản PDF của hướng dẫn này, hãy xem Sách điện tử PHP của chúng tôi từ Tizag. cửa hàng com. In nó ra, viết lên đó, đăng những bài học yêu thích của bạn lên tường của bạn

Nhận xét PHP có thể được sử dụng để mô tả bất kỳ dòng mã nào để nhà phát triển khác có thể hiểu mã dễ dàng. Nó cũng có thể được sử dụng để ẩn bất kỳ mã nào

PHP hỗ trợ chú thích một dòng và nhiều dòng. Những nhận xét này tương tự như nhận xét kiểu C/C++ và Perl (kiểu vỏ Unix)

Nhận xét một dòng PHP

Có hai cách để sử dụng chú thích một dòng trong PHP

  • // (Nhận xét một dòng kiểu C++)
  • # (Nhận xét một dòng kiểu Unix Shell)

đầu ra

Chào mừng bạn đến với nhận xét một dòng PHP

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

Trong PHP, chúng ta cũng có thể nhận xét nhiều dòng. Để làm như vậy, chúng ta cần đặt tất cả các dòng trong /* */. Hãy xem một ví dụ đơn giản về comment nhiều dòng trong PHP

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 nhận xét 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 (

Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>
0) hoặc dấu thăng (
Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>
1) 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

Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>
2 đầu tiên ở trên được nhận xét, vì vậy,
Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>
3 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ị (
    Psst...You can't see my PHP comments!"; // echo "nothing";
    // echo "My name is Humperdinkle!";
    # echo "I don't do anything either";
    ?>
    
    4)
  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 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
1 như thế này

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

PHP comment hint picked up by IDEGợ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 thế nào bình luận được sử dụng trong mã PHP?

Chú thích trong mã PHP là một dòng không được thực thi như một phần của chương trình. Mục đích duy nhất của nó là được đọc bởi một người đang xem mã. Nhận xét có thể được sử dụng để. Hãy để người khác hiểu mã của bạn .

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

Nhận xét có thể được thêm vào một dòng mã ( Ctrl + / ) hoặc khối mã (Ctrl + Shift + /). Ngoài ra, các chú thích PHPDocBlock đặc biệt cũng có thể được thêm vào. Xem "Thêm nhận xét DocBlock PHP" để biết thêm thông tin.