Hướng dẫn dùng php comments trong PHP

Trong quá trình lập trình, để người khác có thể dễ hiểu và theo dõi những đoạn code, bạn có thể sử dụng comment trong code. Để tìm hiểu về comment trong PHP mời bạn đọc cùng eLib tham khảo bài viết dưới đây.

Mục lục nội dung

1. PHP Comment: một dòng

2. PHP Comment: nhiều dòng

3. Kinh nghiệm comment

1. PHP Comment: một dòng

Có hai cách để sử dụng comment một dòng đơn trong PHP.

• // (comment dòng đơn kiểu C/C++)
• # (Nhận xét dòng đơn kiểu Unix)

Ví dụ:

Kết quả:

Ví dụ 1: Comment 1 dòng trong PHP.

2. PHP Comment: nhiều dòng

Trong PHP, chúng ta cũng có thể comment nhiều dòng. Để làm như vậy, chúng ta cần phải để tất cả các dòng bên trong /* comments */. Ví dụ đơn giản về comment nhiều dòng trong PHP.

Kết quả:

Ví dụ 2: Comment nhiều dòng trong PHP.

3. Kinh nghiệm comment

Comment tiêu đề khối lớn

//=======================================================
// CATEGORY LARGE FONT
//=======================================================

Comment tiêu đề phụ

//-----------------------------------------------------
// Sub-Category Smaller Font
//-----------------------------------------------------

Comment trường hợp

# Option 1
# Option 2
# Option 3

Comment đoạn

/*
* This is a detailed explanation
* of something that should require
* several paragraphs of information.
*/

Comment dòng

// This is a single line quote.

Trên đây là bài viết của eLib.VN về comment trong PHP. Hy vọng những nội dung bài viết hữu ích cho quá trình lập trình của bạn. Chúc các bạn thành công!

Comment là một trong những điều quan trọng trong tất cả ngôn ngữ lập trình. Tuy nhiên với PHP – là một ngôn ngữ rất dynamic – mà chúng ta viết dynamic quá => khó hiểu khi ko có comment. Nó khiến cả ng` đọc và ng` viết khó hiểu =)).

Với bài này, tiêu chuẩn là theo PHPDoc, sẽ giúp các bạn comment hữu ích trong ngày thường hơn. Cái câu mà mấy bọn tây hay xài rất hay là: It’ll make your life easier. Vâng, tại sao ko làm cho cuộc đời chúng ta trở nên dễ dàng 1 chút nhỉ? 😀

Với 1 chút công sức nhỏ nhoi này, khi ng` khác đọc code của bạn họ có thể chỉ vào function hay variable rồi Ctrl + B (command+B) => Go to Declaration. Rất ngon và dễ dàng đọc code hơn.

1/ Getting Started with Comment in PHPStorm

Để bắt đầu comment, chúng ta sẽ bất đầu bằng syntax /** (rồi enter) là PHPStorm nó tự hiểu (giống Java ý).

Storm nó khôn lắm, nếu bạn viết function xong mà có return đàng hoàng rồi mới comment, nó cũng sẽ cốtìm và generate ra cho bạn :v. Mà nếu nó bí cái đầu ra của bạn, type của nó return sẽ là mixed (đủ loại =)) )

Ví dụ:

2/ PHPDoc basicX

Các bạn có thấy cái @return ở trên ko? Đó là keyword của PHPDoc đóa. Những keywords mà ta hay sử dụng cho PHPDoc như sau:

KeywordDescription@paramĐầu vào function@returnKiểu trả về của function@varThông tin về variable và kiểu dữ liệu
Sử dụng cho property trong class và variables trong functions@packageThông tin về Namespace của Class@authorTác giả =))@methodThông tin về 1 method trong class.
Thông thường hay define cho 1 dynamic method@propertyThông tin về 1 property trong class
Dynamic property@deprecatedThông tin về deprecated của class hay function@todoNote lại ở khúc nào đó để biết những gì còn cần fải làm (trong hiện tại hoặc tương lai)
Vd: @todo Bug ABX in XYZ fix later after Sprint 3

3/ Đi sâu dần – Diving Deep into this

Comment Function đơn giản

Function nhiều kiểu trả về (demo là chính nha :v)

Loop 1 cái mảng objects mà PHPStorm nó ko biết defined class, gán cho nó để dễ sử dụng functions, properties

...; /// phpstorm nó sẽ suggest đúng vào Class User
    }
}

Cách này ko chỉ define vậy, mà các bạn có thể define 1 đống trong function của bạn thoải mái. Rất tiện.

4/ Tricks

Tricks là điều ko thể thiếu để “make your life easier”. Hehe. Nhớ vài cái để nhớ tiếp mình sẽ share típ =))

Array of Objects

Vâng, các bạn sẽ có cơ hội gặp trường hợp này thoy. Là function của bạn trả về 1 array of objects. Vậy làm gì để khi call function mà nó hiểu kiểu trả về của mình và hiểu trong loop code.

Đơn giản ta define như sau:

(Class[] là các define của ci sáp, di ây vi ây đồ, mà PHPDoc nó hiểu là ok rùi =)) )

Laravel Eloquent

Như các bạn đã biết, Eloquent của Laravel nó dynamic cực kì, khi đã nhận 1 row data vào Model, ta có thể access vào property để lấy ra các cột trong db tương ứng để lấy data hay access vào các methods, relationship data,…

Cơ mà PHPStorm làm gì hiểu dc =)), tốn thời gian chút define thoy.

Ví dụ cho cái User Model nha :3.

Comment các thông tin cơ bản:

Kết quả khi có object User, access thử:

To be continue (updating…)

5/ Kết luận

Make your life easier and also make everybody else’s life easier too. Don’t be so selfish :))

Hãy xài PHPStorm để “Make your life easier” too =)).

Ngoài ra khi bạn comment kiểu này, bạn cũng có thể thông qua PHPDoc để generate ra dc 1 site Documentation. Ngon 😀