PHP comments – một số nguyên tắt sử dụng comments trong php

Tóm tắt: Trong bài hướng dẫn này, bạn sẽ học về các comments trong PHP và một số nguyên tắc khi sử dụng comments để giải thích code PHP của bạn.

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

PHP hỗ trợ hai loại comments:

• Comments một dòng (One-line comments)
• Comments nhiều dòng (Multi-line comments)

Comments một dòng

Comments một dòng được đặt ở cuối dòng hoặc tại khối hiện tại.
Một comments một dòng bắt đầu bằng dấu thăng (#) hoặc hai dấu gạch chéo xuôi (//). Phần còn lại của văn bản sau (//) sẽ bị bỏ qua bởi trình thông dịch PHP.

Ví dụ sau sử dụng // cho một comments một dòng:

<?php

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // tính toán thanh toán

Và ví dụ sau sử dụng # cho một comments một dòng:

<?php

$title = 'PHP comment'; # đặt tiêu đề mặc định

Comments nhiều dòng

Một comments nhiều dòng bắt đầu bằng /* và kết thúc bằng */. Ví dụ:

<?php
/*
   Đây là một ví dụ về comments nhiều dòng,
   có thể bao gồm nhiều dòng.
*/

Trong thực tế, bạn sử dụng comments nhiều dòng khi bạn cần giải thích chúng qua nhiều dòng.

Viết comments có ý nghĩa

Để tài liệu code của bạn một cách hiệu quả, bạn sử dụng các hướng dẫn sau:
Làm cho code nói lên bản thân mình mà không cần sử dụng comments bằng cách đặt tên biến có ý nghĩa. Ví dụ, bạn có thể sử dụng:

$is_completed = true;

Thay vì sử dụng một tên khó hiểu kèm theo comments:

$ic = true; // đã hoàn thành

Mã nguồn có thể là chính là comments tốt.

Không viết comments để giải thích code làm gì, thay vào đó, giải thích tại sao nó lại làm như vậy. Ví dụ:

// hoàn thành nhiệm vụ
$is_completed = true

Khi viết comments, làm cho nó ngắn gọn và dễ hiểu nhất có thể.

Kết luận

• Comments là một phần quan trọng của code vì chúng giải thích tại sao code lại thực hiện những gì nó được thiết kế.
• PHP hỗ trợ cả comments một dòng và comments nhiều dòng.
• Một comments một dòng bắt đầu bằng # hoặc //.
• Một comments nhiều dòng bắt đầu bằng /* và kết thúc bằng */.