Chúng ta nên thêm một dòng nhận xét vào mã PHP như thế nào?
|
Bài viết này sẽ hướng dẫn nhanh cho bạn cách nhận xét mã PHP của bạn bằng nhận xét đơn và nhiều dòng Show
Nhận xét là gì?Nhận xét trong lập trình là một hoặc nhiều dòng văn bản không được hiểu là hướng dẫn lập trình. Thay vào đó, máy tính bỏ qua các dòng nhận xét khi thực thi mã của bạn, hoàn toàn bỏ qua chúng Nhận xét không phải tuân theo bất kỳ cú pháp hợp lệ nào. Chúng chỉ là văn bản mà bạn đọc, còn máy tính thì không Nhận xét có thể kéo dài một hoặc nhiều dòng Nhận xét một dòngNhận xét một dòng là bất kỳ dòng mã PHP nào bắt đầu bằng // (dấu gạch chéo kép) hoặc # (hàm băm) // This is a single line comment echo "This is not a comment"; # This is a single line comment too // Multiple single line comments // Can appear immediately after each other Nhận xét nhiều dòngNhận xét nhiều dòng được chứa trong một cặp dấu /* (dấu gạch chéo lên phía trước) và */ (dấu gạch chéo lên dấu hoa thị) /* Multi line comments can cover multiple lines and each line doesn't need to be started with any special characters */ Các dòng chứa trong bình luận nhiều dòng không cần bắt đầu bằng bất kỳ ký tự đặc biệt nào – mọi thứ bên trong đều được coi là bình luận Quy ước bình luậnNhận xét thường được sử dụng để nói với các nhà phát triển đồng nghiệp của bạn (hoặc tự nhắc nhở bản thân) mục đích của mã PHP – có gì trong một tệp hoặc chức năng của một lớp hoặc chức năng Có một số quy ước xung quanh điều này để các nhận xét nhất quán và mọi người đều nhận được thông tin họ cần Nếu các quy ước này được sử dụng đúng cách, phần mềm như PHPDoc có thể được sử dụng để đọc các nhận xét trong mã của bạn và tự động tạo tài liệu cho dự án của bạn Bình luận các hàm PHPCác hàm PHP thường được nhận xét để bao gồm thông tin về những gì hàm dự kiến sẽ thực hiện, những tham số mà nó chấp nhận và giá trị mà nó trả về /**
* Multiplies two numbers
*
* @param integer $number A number
* @param integer $number The number to multiply the other number by
*
* @return integer
*/
public function getImageNodes($number, $multiplier)
{
return $number * $multiplier;
}Nhận xét các lớp PHPCác lớp cũng nên được nhận xét để giải thích mục đích của chúng và loại đối tượng mà chúng đại diện /**
* Short description for the class
*
* Long description for class if necessary
*
* @copyright 2020 LinuxScrew
* @license https://opensource.org/licenses/MIT
* @version 0.01
* @link https://LinuxScrew.com
* @since Class available since Release 0.01
*/
class MyClass {
// ...
}Bình luận tập tin PHPCác nhà phát triển thường để lại nhận xét ở phần đầu của toàn bộ tệp PHP mô tả những thứ như phiên bản PHP mà nó được viết cho, nơi nó thuộc về và nó được viết bởi ai. /** * Short description of file and contents * * Long description if necessary * * PHP version 8.0 * * LICENSE: https://opensource.org/licenses/MIT * * @category Category Name * @package Package Name * @author Author <[email protected]> * @copyright 2015-2020 LinuxScrew * @license https://opensource.org/licenses/MIT * @version 0.1 * @link https://linuxscrew.com */ Ghi chú nhanh về Nhận xét HTMLCác thẻ nhận xét HTML không được giải thích bởi PHP Vì vậy, mã PHP trong ví dụ mã bên dưới sẽ được thực thi ngay cả khi nó được chứa trong một nhận xét HTML Nếu bạn đang trộn PHP vào HTML, điều này đáng được lưu ý - nội dung lặp lại ở trên sẽ được đưa vào tài liệu HTML, đây có thể là một vấn đề nếu nó chứa thông tin nhạy cảm Nhận xét một dòng có thể được sử dụng trong mã PHP bằng cách sử dụng cú pháp khác. Hai loại chú thích một dòng của mã PHP được hiển thị trong hướng dẫn này. Một là cú pháp nhận xét c++/java và một là cú pháp nhận xét shell. Hai cú pháp sử dụng chú thích một dòng trong PHP được hiển thị trong phần này của hướng dẫn Ví dụ 1. Nhận xét một dòng sử dụng cú pháp c++/javaCác ký tự băm kép (‘//’) được sử dụng để nhận xét trên một dòng trong tập lệnh PHP. Trong tập lệnh sau, năm nhận xét một dòng được sử dụng để giải thích mã. Ở đây, các giá trị ba chuỗi được khai báo và chúng được kết hợp sau đó thành một biến khác. Chú thích một dòng được thêm vào cho mỗi câu lệnh bị trình thông dịch bỏ qua tại thời điểm thực hiện ?php đầu raĐầu ra sau sẽ xuất hiện sau khi thực thi mã. Đầu ra hiển thị các giá trị kết hợp của $str1, $str2 và $str3. Tất cả các nhận xét một dòng đã bị trình thông dịch bỏ qua Ví dụ-2. Nhận xét một dòng sử dụng cú pháp trình baoKý hiệu '#' được sử dụng cho nhận xét một dòng trong tập lệnh shell được hỗ trợ bởi PHP. Tập lệnh PHP sau đây tính toán xem năm hiện tại có phải là năm nhuận hay không. Hàm tùy chỉnh isLeap() được sử dụng ở đây để tính xem năm hiện tại có phải là năm nhuận hay không. Nhận xét một dòng được sử dụng trong mã để làm cho tập lệnh dễ đọc hơn đối với người đọc. Ở đây, hàm date() được sử dụng để đọc năm hiện tại được đề cập trong bình luận. Tiếp theo, hàm mktime() dùng để kiểm tra xem năm đó có phải là năm nhuận hay không. Nếu năm đó là năm nhuận, thì hàm mktime() sẽ trả về 1 và ký tự định dạng 'L' được sử dụng trong hàm date() cho năm nhuận. Các nhận xét một dòng cần thiết được sử dụng trong tập lệnh ?php đầu raĐầu ra sau sẽ xuất hiện sau khi thực thi mã. Đầu ra cho thấy năm hiện tại, 2020, là một năm nhuận và tất cả các nhận xét một dòng đã bị trình thông dịch bỏ qua Nhận xét nhiều dòngNhận xét nhiều dòng được sử dụng để thêm nhận xét văn bản dài. Nếu coder cần giải thích chi tiết chức năng của code để hiểu rõ hơn thì có thể thêm comment nhiều dòng cho code đó. '/*' được sử dụng ở đầu bình luận và '*/' được sử dụng ở cuối bình luận. Loại chú thích nhiều dòng này được sử dụng trong bất kỳ ngôn ngữ lập trình tiêu chuẩn nào, chẳng hạn như Java, C++, v.v. Chú thích nhiều dòng chủ yếu được sử dụng ở đầu bất kỳ tập lệnh nào để cung cấp thông tin chi tiết về tập lệnh, người viết kịch bản, phiên bản, liên kết của mã nguồn, v.v. Ví dụ-3. Nhận xét nhiều dòng bằng cách sử dụng '/*…*/'Trong tập lệnh sau, ba nhận xét nhiều dòng được sử dụng để giải thích mã. Nhận xét đầu tiên mô tả chức năng của tập lệnh. Nhận xét thứ hai giải thích chức năng của hàm rand(). Nhận xét thứ ba giải thích mục đích của hàm isPrime(). Một số ngẫu nhiên từ 1 đến 100 sẽ được tạo mỗi khi tập lệnh thực thi và hàm isPrime() sẽ tìm hiểu xem số đó có phải là số nguyên tố hay không. Nếu hàm trả về giá trị true thì số đó là số nguyên tố. Mặt khác, số không phải là số nguyên tố ?php đầu raĐầu ra của tập lệnh sẽ thay đổi trong mỗi lần thực hiện do số ngẫu nhiên. Đầu ra sau xuất hiện sau khi thực thi mã lần đầu tiên và nó sẽ được thay đổi trong lần thực thi tiếp theo. Nếu số ngẫu nhiên được tạo là số nguyên tố thì isPrime() sẽ trả về 1 và nếu số ngẫu nhiên được tạo không phải là số nguyên tố thì isPrime() sẽ trả về 0 Phần kết luậnMọi tập lệnh tiêu chuẩn đều chứa các nhận xét để giúp người đọc hiểu đúng mã. Nhiều lập trình viên mới không thêm nhận xét vào tập lệnh của họ khiến mã khó hiểu đối với các lập trình viên khác. Vì vậy, khi bạn viết bất kỳ câu lệnh nào, thì bạn nên thêm chú thích cho từng câu lệnh Chúng ta nên thêm một dòng nhận xét vào mã PHP Mcq của mình như thế nào?7. Chúng ta nên thêm một dòng nhận xét vào mã PHP như thế nào? . /* */ cũng có thể được sử dụng để nhận xét chỉ một dòng mặc dù nó được sử dụng cho các đoạn văn. // và # chỉ được sử dụng cho chú thích một dòng. số 8.
Bạn sẽ viết một dòng chú thích trong tài liệu PHP như thế nào?Nhận xét PHP một dòng
. Tất cả văn bản ở bên phải của // sẽ bị bỏ qua. Bạn cũng có thể sử dụng ký hiệu băm (#) thay vì // để tạo nhận xét một dòng. type two forward slashes (//) followed by your comment text. All text to the right of the // will be ignored. You can also use a hash symbol (#) instead of // to make a single-line comment.
Toán tử nhận xét một dòng có được sử dụng trong PHP không?PHP hỗ trợ nhận xét 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).
Biểu tượng nào chúng ta thêm một dòng nhận xét trong mã PHP của mình?Biểu tượng '#' được sử dụng cho nhận xét một dòng trong tập lệnh shell được hỗ trợ bởi PHP. |
