Comment trong PHP

Comment trong PHP
Comment trong PHP

Comment trong PHP là gì?

Comment trong PHP là một loại chú thích của PHP, lập trình viên có thể chú thích bằng một dòng hoặc nhiều dòng, những dòng chú thích không tham gia thực thi code và không hiện ra trên giao diện người dùng, nó cho phép chú thích để hiểu rõ thêm đoạn code được viết.

Cú pháp của Comment trong PHP

// Nội_dung_comment_trên_1_dòng

Nội_dung_comment_trên_1_dòng: Nội dung comment trên 1 dòng (Thêm dấu // trước nội dung comment 1 dòng).

# Nội_dung_comment_trên_1_dòng

Nội_dung_comment_trên_1_dòng: Nội dung comment trên 1 dòng (Thêm dấu # trước nội dung comment 1 dòng)

/*
Nội_dung_comment_trên_nhiều_dòng
Nội_dung_comment_trên_nhiều_dòng
Nội_dung_comment_trên_nhiều_dòng
*/

Bao gồm thẻ mở /* và thẻ đóng */

Các loại Comment trong PHP

Comment một dòng trong PHP

<?php
//chú thích Chạy thử Comment một dòng trong PHP
#chú thích Chạy thử Comment một dòng trong PHP
echo "Chạy thử Comment một dòng trong PHP";
?>

Kết quả:

Chạy thử Comment một dòng trong PHP

Dùng dấu // và dấu # để chú thích 1 dòng trong PHP

Chạy Thử

Comment nhiều dòng trong PHP

<?php
/*
Chạy thử 
Comment 
nhiều dòng 
trong PHP
*/
echo "Chạy thử Comment nhiều dòng trong PHP";
?>

Kết quả:

Chạy thử Comment nhiều dòng trong PHP

Dùng dấu /* */ để chú thích nhiều dòng.

Chạy Thử

Lưu ý khi sử dụng Comment trong PHP

Comment giúp mã PHP dễ đọc và thuận tiện hơn khi bảo trì, nhưng hiệu quả chỉ đạt được khi nội dung chú thích thực sự hữu ích. Một comment tốt nên giải thích lý do hoặc mục đích của đoạn code, thay vì lặp lại chính xác những gì code đã thể hiện.

Không nên lạm dụng Comment trong PHP

Không cần viết comment cho mọi dòng lệnh hoặc những đoạn code đã quá rõ ràng. Quá nhiều chú thích khiến mã nguồn dài, khó theo dõi và có thể trở thành thông tin lỗi thời khi logic bên trong được thay đổi.

Thay vì giải thích từng câu lệnh, nên ưu tiên comment ở những vị trí có logic đặc biệt, cách xử lý dễ gây nhầm lẫn hoặc cần làm rõ lý do lựa chọn một phương án cụ thể.

<?php
// Tạm thời bỏ qua bản ghi đã bị khóa để tránh cập nhật ngoài ý muốn.
if ($record['locked']) {
    continue;
}

Trong ví dụ trên, comment bổ sung lý do xử lý thay vì diễn giải lại điều kiện if. Cách viết này giúp người khác nhanh chóng hiểu ý đồ của đoạn code.

Không đặt thông tin nhạy cảm trong Comment

Comment không phải nơi phù hợp để lưu mật khẩu, API key, token, thông tin đăng nhập hoặc dữ liệu nội bộ. Dù comment không được thực thi, nội dung này vẫn tồn tại trong mã nguồn và có thể bị nhìn thấy khi code được chia sẻ, sao lưu hoặc đưa lên hệ thống quản lý phiên bản.

Nếu cần ghi chú cấu hình, chỉ nên mô tả mục đích hoặc hướng dẫn chung và lưu thông tin bí mật ở nơi phù hợp, chẳng hạn biến môi trường hoặc hệ thống quản lý cấu hình.

<?php
// API key được đọc từ biến môi trường.
$apiKey = getenv('API_KEY');

Cách này vừa giúp người đọc hiểu nguồn dữ liệu, vừa tránh đưa thông tin bí mật trực tiếp vào mã PHP.

Lời kết

Cảm ơn các bạn đã tham khảo bài viết Comment trong PHP.

  • 0 Bình luận
Trần Thị Vân | Content Creator Web Mới
Trần Thị Vân
Trần Thị Vân là Content Creator tại Web Mới, phụ trách nghiên cứu, biên soạn nội dung và chia sẻ kiến thức về website, SEO, lập trình cùng các xu hướng công nghệ
Đánh giá
Chia sẻ nội dung đánh giá của bạn về Comment trong PHP
Email, Điện thoại của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *
Đánh giá của bạn
Tên *
Email
Số điện thoại *
Bình luận, Hỏi đáp
Yêu Cầu Báo Giá
Gửi trang web mẫu cần làm theo, chúng tôi sẽ báo giá đến bạn từ Email (tanlucit09@gmail.com - Bùi Tấn Lực) hoặc Zalo (Lực IT - 0398259259) !