Hướng dẫn phpdoc intellij - phpdoc intellij

Cài đặt plugin PHP

Chức năng này dựa trên plugin PHP cần được cài đặt và bật trong IDE của bạn.

Plugin chỉ có sẵn trong IntelliJ & nbsp; Idea Ultimate.

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

2. Chuyển sang tab Marketplace và sử dụng trường tìm kiếm để tìm plugin PHP.Marketplace tab and use the search field to find the PHP plugin.

3. Nhấp vào Cài đặt và khởi động lại IDE nếu được nhắc.Install and restart the IDE if prompted.

Kích hoạt ý kiến ​​tài liệu

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

2. Chuyển sang tab Marketplace và sử dụng trường tìm kiếm để tìm plugin PHP.Enter section, select or clear Insert documentation comment stub checkbox.

Nhấp vào Cài đặt và khởi động lại IDE nếu được nhắc.

1. Kích hoạt ý kiến ​​tài liệu

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

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

   • Để 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:Generate PHPDoc blocks, and choose the code construct to generate PHPDoc comments for.

   

   Đặ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.

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.

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.

Intellij & nbsp; Idea 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 một khối tài liệu.

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

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

3. Intellij & nbsp; Idea 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 một 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.

Trong một khối PHPDOC, chọn dòng trống mong muốn và nhấn không gian Ctrl+.

Chọn thẻ có liên quan từ danh sách đề xuất.

1. Nếu thẻ đã nhập có một số giá trị, hãy nhấn Ctrl+Space và chọn giá trị mong muốn từ danh sách đề xuất.Settings/Preferences dialog (Ctrl+Alt+S), go to .

2. Định cấu hình định dạng bên trong các bình luận của PHPDOCPHPDoc tab an configure the desired appearance options by selecting or clearing the checkboxes.

3. Bạn có thể định cấu hình sự xuất hiện của các nhận xét PHPDOC, 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 các thuộc tính không còn có thể định cấu hình, thẻ @var mặc định được chèn tự động. Xem https://github.com/phpdocumentor/fig-standards/pull/55 để biết chi tiết.return and throws values, and so on, by selecting or clearing the Use fully-qualified class names checkbox.

4. Trong hộp thoại Cài đặt/Tùy chọn (CTRL+ALT+S), hãy truy cập.Sort PHPDoc tags checkbox.

   • Chuyển sang tab PHPDOC Một cấu hình các tùy chọn xuất hiện mong muốn bằng cách chọn hoặc xóa các hộp kiểm. and to add or remove the PHPDoc tag entries from the list.

   • Chỉ định cách bạn muốn IntelliJ & NBSP; Ý tưởng 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 các giá trị, v.v., bằng cách chọn hoặc xóa hộp kiểm Sử dụng tên lớp có đủ điều kiện đầy đủ. and to arrange the PHPDoc tag entries order.

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

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