PHP commnt - Hướng dẫn ngắn cho người mới bắt đầu

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 bình luận:

• 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 ( #) 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:

<?php

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // payout calculationNgôn ngữ mã:  HTML, XML  ( xml )

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

<?php

$title = 'PHP comment'; # set default titleNgôn ngữ mã:  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ụ:

<?php
/*
   This is an example of a multi-line comment,
   which can span multiple lines.
*/Ngôn ngữ mã:  HTML, XML  ( xml )

Trong thực tế, bạn sử dụng chú thích nhiều dòng khi bạn cần mở rộng các chú thích trên 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:

$is_completed = true;Ngôn ngữ mã:  PHP  ( php )

Thay vì sử dụng một cái tên khó hiểu với một bình luận:

$ic = true; // is completedNgôn ngữ mã:  PHP  ( php )

Bản thân mã có thể là nhận xét tốt.

2) Đừng viết bình luận để giải thích mã làm gì, thay vào đó, hãy giải thích tại sao nó làm như vậy. Ví dụ:

// complete the task
$is_completed = trueNgôn ngữ mã:  PHP  ( php )

3) Khi viết bình luận, hãy làm cho nó ngắn gọn nhất có thể.

Bản tóm tắt

• Nhận xét là phần quan trọng của mã vì chúng giải thích tại sao mã làm những gì nó phải làm.
• PHP hỗ trợ cả chú thích một dòng và nhiều dòng.
• Nhận xét một dòng bắt đầu bằng #hoặc // .
• Nhận xét nhiều dòng bắt đầu bằng /*và kết thúc bằng */.