Hướng dẫn php generate documentation from comments - php tạo tài liệu từ các bình luận

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. 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. Để 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:

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

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

   

   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.

2. 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ã.

Tạo thẻ trong khối bình luận 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 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.

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

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

3. 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.

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

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.

1. Trong hộp thoại Cài đặt/Tùy chọn (CTRL+ALT+S), hãy truy cập.Settings/Preferences dialog (Ctrl+Alt+S), go to .

2. 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.PHPDoc tab an configure the desired appearance options by selecting or clearing the checkboxes.

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 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 đủ.return and throws values, and so on, by selecting or clearing the Use fully-qualified class names checkbox.

4. 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.Sort PHPDoc tags checkbox.

   • Sử dụng và để thêm hoặc xóa các mục thẻ PHPDOC khỏi danh sách. and to add or remove the PHPDoc tag entries from the list.

   • Sử dụng và để sắp xếp các mục nhập thẻ PHPDOC. and to arrange the PHPDoc tag entries order.

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

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