Định dạng PHPDoc

Bật nhận xét tài liệu

1. Nhấn Ctrl+Alt+S để mở cài đặt IDE và chọn Trình chỉnh sửa. Chung. Chìa khóa thông minh .

2. Trong phần Nhập , chọn hoặc xóa Chèn sơ khai nhận xét tài liệu checkbox.

Tạo khối PHPDoc cho cấu trúc mã

1. Để gọi việc tạo khối PHPDoc, hãy thực hiện một trong các thao tác sau

   • Đặt dấu mũ trước cấu trúc mã được yêu cầu [lớp, phương thức, chức năng, v.v.], nhập nhận xét khối mở đầu /**, rồi nhấn Enter

   • Trong menu ngữ cảnh của trình chỉnh sửa, hãy chọn Tạo. Tạo khối PHPDoc và chọn cấu trúc mã để tạo nhận xét PHPDoc cho.

   • Nhấn Alt+Insert, sau đó chọn Tạo khối PHPDoc và chọn cấu trúc mã để tạo nhận xét PHPDoc cho.

   PhpStorm phân tích cấu trúc mã được chỉ định, trích xuất dữ liệu cho các tham số, giá trị trả về, biến hoặc trường nếu có thể và trên cơ sở này tạo ra một sơ khai của khối tài liệu

2. Mô tả các tham số được liệt kê và trả về giá trị khi cần thiết. PhpStorm kiểm tra và xử lý cú pháp trong các bình luận theo

Tạo thẻ trong khối nhận xét PHPDoc

PhpStorm phân tích cấu trúc mã được chỉ định, trích xuất dữ liệu cho các tham số, giá trị trả về, biến hoặc trường nếu có thể và trên cơ sở này tạo ra một sơ khai của khối tài liệu. Nếu cần, bạn có thể điền thông tin còn thiếu

1. Trong khối PHPDoc, chọn dòng trống mong muốn và nhấn Ctrl+Space

2. Chọn thẻ có liên quan từ danh sách gợi ý

3. Nếu thẻ đã nhập có nhiều giá trị, hãy nhấn Ctrl+Dấu cách và chọn giá trị mong muốn từ danh sách gợi ý

Định cấu hình định dạng bên trong nhận xét PHPDoc

Bạn có thể định cấu hình giao diện của nhận xét PHPDoc, cách trình bày tên lớp và thứ tự sắp xếp thẻ mặc định. Lưu ý rằng thẻ cho thuộc tính không thể định cấu hình được nữa, thẻ mặc định được chèn tự động. Xem https. //github. com/phpDocumentor/fig-standards/pull/55 để biết chi tiết

1. Trong hộp thoại Cài đặt [Ctrl+Alt+S], chuyển đến Trình chỉnh sửa. Kiểu mã. PHP .

2. Chuyển sang tab PHPDoc và định cấu hình các tùy chọn giao diện mong muốn bằng cách chọn hoặc bỏ chọn các hộp kiểm.

3. Chỉ định cách bạn muốn PhpStorm trình bày tên lớp cho các thuộc tính, tham số chức năng, trả về và ném . values, and so on, by selecting or clearing the Use fully-qualified class names checkbox.

4. Nếu cần, hãy xác định cách sắp xếp các thẻ PHPDoc đã tạo bằng cách chọn hộp kiểm Sắp xếp các thẻ PHPDoc .

   • Sử dụng và để thêm hoặc xóa các mục thẻ PHPDoc khỏi danh sách.

   • Sử dụng và để sắp xếp thứ tự mục nhập thẻ PHPDoc.

   Các thẻ PHPDoc không được thêm vào danh sách được tạo bên dưới các thẻ được liệt kê

Hiển thị nhận xét PHPDoc

PhpStorm cho phép bạn hiển thị nhận xét PHPDoc trong trình chỉnh sửa. Nhận xét được hiển thị dễ đọc hơn và chúng không làm quá tải mã của bạn bằng các thẻ phụ

Nhấp vào trong rãnh bên cạnh nhận xét tài liệu cần thiết [hoặc nhấn Ctrl+Alt+Q] để chuyển chế độ xem được hiển thị; . to edit the comment.

Nhận xét PHPDoc được hiển thị cho phép bạn nhấp vào liên kết để truy cập các trang web được tham chiếu hoặc xem các chủ đề được tham chiếu

Để thay đổi kích thước phông chữ, nhấp chuột phải vào nhận xét PHPDoc trong trình chỉnh sửa và chọn Điều chỉnh kích thước phông chữ từ trình đơn ngữ cảnh. Lưu ý rằng các nhận xét được hiển thị sử dụng cùng kích thước phông chữ như cửa sổ bật lên tài liệu nhanh.

Sử dụng kiểm tra mã PHPDoc

PhpStorm cung cấp một bộ kiểm tra mã được xác định trước nhắm vào các khối PHPDoc. Các kiểm tra này kiểm tra xem các lớp, phương thức, hàm, biến và hằng số có được cung cấp cùng với nhận xét PHPDoc hay không và liệu các thẻ trong nhận xét có khớp với mục được ghi lại không