Hướng dẫn php comment documentation - tài liệu bình luận php

1. Nhấn CTRL+ALT+S để mở cài đặt IDE và chọn.

2. Trong phần Enter, chọn hoặc xóa Chèn tài liệu Nhận xét STUB STUB.Enter section, select or clear Insert documentation comment stub checkbox.

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

1. Tạo thẻ trong khối bình luận PHPDoc

   • Định cấu hình định dạng bên trong các bình luận của PHPDOC

   • Sử dụng kiểm tra mã PHPDOC

   • Bật hoặc tắt kiểm tra PHPDOCGenerate PHPDoc blocks, and choose the code construct to generate PHPDoc comments for.

   Kiểm tra xem các nhận xét PHPDoc có được cung cấp cho các cấu trúc mã của một loại nhất định không

2. Nếu bạn cần các thẻ cụ thể PHP bổ sung, phpstorm cung cấp hoàn thành mã cho thấy các tên thẻ có liên quan trong bối cảnh hiện tại. Nếu một thẻ nhất định có nhiều giá trị, hoàn thành mã cung cấp một danh sách các giá trị có sẵn.

Trong các bình luận của PHPDOC, Phpstorm hỗ trợ các tùy chọn định dạng tuân thủ các tiêu chuẩn mã hóa, PEAR và các tiêu chuẩn mã hóa khác.

1. Nhận xét của PHPDOC trong mã nguồn của bạn có sẵn để tra cứu tài liệu nhanh, giúp bạn có được thông tin nhanh chóng cho bất kỳ biểu tượng được ghi chép nào. Bạn có thể mở chúng để xem xét trong cửa sổ Công cụ Tài liệu bằng cách nhấn Ctrl+Q.

2. Nhấn CTRL+ALT+S để mở cài đặt IDE và chọn.

3. Trong phần Enter, chọn hoặc xóa Chèn tài liệu Nhận xét STUB STUB.

Để gọi thế hệ của một khối PHPDOC, hãy thực hiện một trong những điều sau đây:

1. Đặt Caret trước cấu trúc mã cần thiết [lớp, phương thức, chức năng, v.v.], nhập nhận xét khối mở /** và nhấn Enter.Settings/Preferences dialog [Ctrl+Alt+S], go to .

2. Trong menu ngữ cảnh trình chỉnh sửa, chọn và chọn cấu trúc mã để tạo các nhận xét PHPDoc cho.PHPDoc tab an configure the desired appearance options by selecting or clearing the checkboxes.

3. Nhấn Alt+Chèn, sau đó chọn Tạo các khối PHPDOC và chọn cấu trúc mã để tạo các nhận xét PHPDoc cho.return and throws values, and so on, by selecting or clearing the Use fully-qualified class names checkbox.

4. 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 cuống của khối tài liệu.Sort PHPDoc tags checkbox.

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

   • 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 cuống của khối tài liệu. Nếu cần thiết, bạn có thể điền vào thông tin bị thiếu.

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

Bật hoặc tắt kiểm tra PHPDOC