Bài viết này giải thích cho bạn cách sử dụng phpDoc, để làm cho mã Laravel của riêng bạn dễ đọc hơn. Mình lưu ý là một số thủ thuật cũng có thể áp dụng cho các dự án PHP khác như Symfony, WordPress, Drupal nhưng hơi khác một chút
Nội dung chính Hiển thị
- Tùy chọn
- Complete to the PHPDoc tags
- Loại trừ IntelliSense
- Loại chú thích
- thuốc gốc
- Thi Thiên/PHPStan
- Chú thích lớp học
- Xác thực mã
- format
- PHPDoc là gì và tại sao bạn lại sử dụng nó?
- PHPDoc trong PhpStorm là gì?
- Nhận xét PHPDoc là gì?
- Khối tài liệu là gì?
Nếu bạn đã sử dụng Laravel một thời gian, bạn phải biết rằng các Mô hình của Laravel sử dụng rất nhiều phương thức kỳ diệu như __get và __set. Chúng được sử dụng để truy cập các giá trị của bạn, đã được tải từ cơ sở dữ liệu của bạn
PHPDoc được chèn vào bên dưới mã định dạng có chứa địa chỉ. Unable information is could not be into. To transfer between the fields, click
/** @ignore */
function a_dummy_function[] { . }Tùy chọn
Thao tác này có thể bị tắt hoặc bật [nó được bật theo mặc định] trong cửa sổ Tùy chọn của Visual Studio [Công cụ/Tùy chọn], trong Trình soạn thảo văn bản/PHP/Nâng cao, tùy chọn
/** @ignore */
function a_dummy_function[] { . }Complete to the PHPDoc tags
Trình chỉnh sửa công cụ PHP cũng cung cấp phần hoàn thành và trích đoạn cho các thẻ PHPDoc. Đặt dấu phụ trong khối PHPDoc và nhập
/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }Hoàn thành thẻ bằng
/** @ignore */
function a_dummy_function[] { . }Văn bản bên trong PHPDoc được sử dụng cho mục đích tài liệu. Nó có thể là một hoặc nhiều dòng văn bản. Nó sẽ có sẵn trong mẹo công cụ nhanh, trong phần trợ giúp chữ ký hoặc trong mẹo công cụ hoàn thành mã
mẹo công cụ nhanh trên màn hình hiển thị thông tin từ nhận xét PHPDoc tương ứng
Loại trừ IntelliSense
Trong một số trường hợp, chức năng đại diện cho một khai báo giả và không được các nhà phát triển sử dụng hoặc không được nhìn thấy trong IntelliSense. Sử dụng thẻ PHPDoc
/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }Ví dụ về chức năng sẽ không được liệt kê trong IntelliSense
Loại chú thích
Có một số thẻ PHPDoc có thể được sử dụng để chú thích các tham số của hàm, giá trị trả về của hàm, loại thuộc tính, loại hằng số hoặc loại biến. Các thẻ PHPDoc tiêu chuẩn như sau
5. only type tham số và mô tả trong biểu mẫu./** @ignore */ function a_dummy_function[] { . }
6/** @ignore */ function a_dummy_function[] { . }
7. cung cấp thông tin về giá trị trả về ở định dạng./** @ignore */ function a_dummy_function[] { . }
8/** @ignore */ function a_dummy_function[] { . }
9. cho phép chú thích các thuộc tính, hằng, hằng lớp./** @ignore */ function a_dummy_function[] { . }
230/** @ignore */ function a_dummy_function[] { . }
231. chú thích các biến toàn cầu trong phạm vi hiện tại./** @ignore */ function a_dummy_function[] { . }
232/** @ignore */ function a_dummy_function[] { . }
To comment a local variable, tag
/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }Chú thích cũng có thể được đặt trên một dòng
/** @ignore */
function a_dummy_function[] { . }Hoặc tên biến có thể bị loại bỏ hoàn toàn nếu nó có thể được suy ra từ câu lệnh bên dưới nó
/** @ignore */
function a_dummy_function[] { . }thuốc gốc
Trình chỉnh sửa các chú thích loại chung [còn được gọi là mẫu]
Lớp/hàm với các loại đối số mẫu được chú thích bằng thẻ PHPDoc
/** @ignore */
function a_dummy_function[] { . }Lưu ý, chú giải công cụ cho lớp
/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }Để sử dụng các đối số kiểu mẫu, hãy chỉ định chúng là bất kỳ kiểu nào khác trong PHPDoc
Lưu ý, biên tập viên sẽ thay thế
/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }/** @ignore */
function a_dummy_function[] { . }Thi Thiên/PHPStan
Trình tạo mã của bên thứ 3 như Psalm hoặc PHPStan giới thiệu các chú thích loại PHPDoc mở rộng. Chúng cũng được hỗ trợ bởi PHP Tools Editor
Các loại có thể được chỉ định trong các dạng thức khác nhau bao gồm
285/** @ignore */ function a_dummy_function[] { . }
284/** @ignore */ function a_dummy_function[] { . }
287/** @ignore */ function a_dummy_function[] { . }
288/** @ignore */ function a_dummy_function[] { . }
289/** @ignore */ function a_dummy_function[] { . }
289/** @ignore */ function a_dummy_function[] { . }
Các thẻ PHPDoc could have a money is
/** @ignore */
function a_dummy_function[] { . }Biên tập viên Tôn trọng những chú thích đó nhưng không thể tận dụng hết lợi thế của họ [chưa]
Chú thích lớp học
Có một số thẻ PHPDoc dành riêng cho khai báo lớp/giao diện
293 cho phép mô tả tên lớp cơ sở bao gồm các đối số kiểu chung của nó. Ví dụ./** @ignore */ function a_dummy_function[] { . }
294/** @ignore */ function a_dummy_function[] { . }
295 cho phép mô tả một giao diện đã được khai triển với các kiểu đối số chung của nó. Ví dụ./** @ignore */ function a_dummy_function[] { . }
296/** @ignore */ function a_dummy_function[] { . }
297 được sử dụng phụ trên một đặc điểm sử dụng để mô tả các đối số loại chung của nó/** @ignore */ function a_dummy_function[] { . }
298 khai báo một phương thức trong trường hợp Lớp cung cấp các phương thức động thông qua hàm/** @ignore */ function a_dummy_function[] { . }
299 ma thuật. Thông báo này được sử dụng khi hoàn thành mã để cung cấp phương thức bổ sung này trong danh sách/** @ignore */ function a_dummy_function[] { . }
70 tương tự như_/** @ignore */ function a_dummy_function[] { . }
298 cho phép xác định thuộc tính động/** @ignore */ function a_dummy_function[] { . }
72 yêu cầu biên tập viên đưa các thành viên thuộc loại khác [còn gọi là mixin] vào lớp này/** @ignore */ function a_dummy_function[] { . }
Xác thực mã
PHPDoc đã được xác thực đối với loại tên hợp lệ, tên thẻ hợp lệ và biến chính tả sai
Đối với các bản sửa lỗi nhanh, có các quy tắc giống như đối với mã PHP;. Trong trường hợp tên loại không rõ ràng hoặc cần phải đủ điều kiện, tiền tố
/** @ignore */
function a_dummy_function[] { . }format
Khối nhận xét PHPDoc được định dạng theo lệnh bên dưới mà nó tương ứng với. Khối được định dạng theo tiêu chuẩn, thụt lề
PHPDoc là gì và tại sao bạn lại sử dụng nó?
PhpDoc, bản viết tắt của PhpDocumentor, là một công cụ mạnh mẽ cho phép bạn dễ dàng ghi lại mã của mình thông qua các nhận xét được định dạng đặc biệt . Tài liệu sẽ có sẵn không chỉ trong mã nguồn mà còn trong tài liệu chuyên nghiệp được trích xuất bằng web hoặc giao diện dòng lệnh.
PHPDoc trong PhpStorm là gì?
Trong các nhận xét PHPDoc, PhpStorm hỗ trợ các tùy chọn định dạng dẻo dai thủ công ZEND, PEAR và các tiêu chuẩn mã hóa khác . Nhận xét PHPDoc trong mã nguồn của bạn có sẵn để Tra cứu tài liệu nhanh chóng, giúp bạn có được thông tin nhanh chóng cho bất kỳ biểu tượng tài liệu nào.
Nhận xét PHPDoc là gì?
Nhận xét Tài liệu PHP [PHPDoc] PHPDoc là một cách tiêu chuẩn để tạo tài liệu và chú thích mã PHP . Đây là một định dạng nổi tiếng của các chú thích khối có tiền tố là /** ký tự và nó được sử dụng để chú thích các hàm, lớp, thuộc tính và tất cả các bộ biến cục bộ.
Khối tài liệu là gì?
Trong quá trình thiết lập, docblock hoặc DocBlock là một nhận xét được định dạng đặc biệt chỉ được xác định trong mã nguồn được sử dụng để ghi lại một đoạn mã cụ thể