Làm cách nào để chạy phpDocumentor?

phpDocumentor là một ứng dụng có khả năng phân tích mã nguồn PHP và các nhận xét DocBlock của bạn để tạo ra một bộ Tài liệu API hoàn chỉnh

Lấy cảm hứng từ phpDocumentor 1 và JavaDoc, nó tiếp tục đổi mới và cập nhật các công nghệ và tính năng ngôn ngữ PHP mới nhất

phpDocumentor v3 (Ổn định)

v3 là bản phát hành ổn định mới nhất

Tài liệu

Để biết thêm thông tin chi tiết, bạn có thể kiểm tra tài liệu trực tuyến của chúng tôi tại https. // tài liệu. phpdoc. tổ chức/

Đặc trưng

phpDocumentor hỗ trợ như sau

• PHP7. 0+ tương thích, hỗ trợ đầy đủ cho Không gian tên, Đóng cửa và hơn thế nữa được cung cấp
• Docblock trên các loại, docblocks có thể rõ ràng hơn về các loại không phải tất cả các định dạng đều được hỗ trợ bởi php gốc
• Hiển thị bất kỳ thẻ nào, một số thẻ thêm chức năng bổ sung vào phpDocumentor (chẳng hạn như @link)
• Mức sử dụng bộ nhớ thấp, mức sử dụng bộ nhớ cao nhất cho các dự án nhỏ là dưới 20 MB, các dự án trung bình là 40 MB và các khung lớn là 100 MB
• Phân tích cú pháp gia tăng, nếu bạn giữ tệp Cấu trúc từ lần chạy trước, bạn sẽ nhận được mức tăng hiệu suất bổ sung lên tới 80% ngoài mức tăng tốc độ xử lý đã đề cập ở trên
• Tạo template dễ dàng, muốn làm thương hiệu chỉ cần gọi 1 tác vụ và chỉnh sửa 3 file
• Quy trình gồm hai bước, trước tiên, phpDocumentor sẽ tạo bộ đệm với cấu trúc ứng dụng của bạn trước khi tạo đầu ra. Nếu bạn muốn, bạn có thể sử dụng nó để cung cấp năng lượng cho các công cụ hoặc trình định dạng của riêng mình
• Hỗ trợ chung, với nhiều phân tích tĩnh hơn trong các loại php đã trở nên phức tạp hơn. phpDocumentor hiểu các loại này. Và sẽ hiển thị chúng dưới dạng loại hạng nhất

Cài đặt

PhpDocumentor yêu cầu PHP 7. 4 hoặc cao hơn để chạy. Tuy nhiên, mã của các phiên bản PHP trước đó có thể được phân tích

Tất cả các mẫu được cung cấp với phpDocumentor đều có hỗ trợ cho Sơ đồ lớp dựa trên cơ sở mã đọc. Điều này sẽ yêu cầu cài đặt ứng dụng Graphviz trên máy chạy phpDocumentor. Hiển thị sơ đồ lớp bằng Graphviz là tùy chọn và có thể bỏ qua các cảnh báo về việc thiếu Graphviz. Tuy nhiên, tài liệu của bạn sẽ chứa một số liên kết chết trong trường hợp này. Sơ đồ lớp sẽ được tạo với tùy chọn --setting=graphs.enabled=true

Có 3 cách để cài đặt phpDocumentor

1. Sử dụng phive (được khuyến nghị)
2. Sử dụng PHAR (cài đặt thủ công)
3. Qua Docker
4. Thông qua nhà soạn nhạc

Sử dụng Phive

$ phive install --force-accept-unsigned phpDocumentor

Để biết thêm thông tin về phive, hãy xem trang web của họ. Bây giờ bạn đã cài đặt phpDocumentor, nó có thể được thực thi như thế này

php tools/phpDocumentor

Sử dụng PHAR

1. Tải xuống tệp phar từ https. //github. com/phpDocumentor/phpDocumentor/bản phát hành
2. Bạn có thể thực hiện phar như thế này. php phpDocumentor.phar

Qua Docker

1. $ docker pull phpdoc/phpdoc
2. $ docker run --rm -v $(pwd):/data phpdoc/phpdoc

Qua Composer (không khuyến nghị)

Nhưng đợi đã?

Ah, bạn đã phát hiện ra bí mật của chúng tôi. Có một gói soạn thảo phpdocumentor mà bạn có thể sử dụng để cài đặt phpDocumentor

Tuy nhiên. phpDocumentor là một ứng dụng phức tạp và các thư viện của nó được sử dụng trong vô số thư viện và ứng dụng khác (2 trong số các thư viện của chúng tôi có hơn 150 triệu lượt tải xuống mỗi thư viện); . Và khi tôi nói cao, nó thực sự cao

Vì vậy, vì những điều trên. chúng tôi không xác nhận cũng như không tích cực hỗ trợ cài đặt phpDocumentor bằng Composer

LÊ

Bắt đầu từ phpDocumentor v3, chúng tôi đã quyết định bỏ hỗ trợ PEAR do việc sử dụng giảm dần

Làm cách nào để sử dụng phpDocumentor?

Cách dễ nhất để chạy phpDocumentor là chạy lệnh sau

$ phpdoc run -d  -t 

Lệnh này sẽ phân tích cú pháp mã nguồn được cung cấp bằng cách sử dụng đối số -d và xuất nó vào thư mục được chỉ định bởi đối số -t

phpDocumentor hỗ trợ toàn bộ các tùy chọn để định cấu hình đầu ra của tài liệu của bạn. Bạn có thể thực hiện lệnh sau hoặc kiểm tra trang web của chúng tôi để biết danh sách chi tiết hơn về các tùy chọn dòng lệnh có sẵn

$ phpdoc run -h

(Các) tệp cấu hình

phpDocumentor cũng hỗ trợ sử dụng các tệp cấu hình (có tên là phpdoc. xml hoặc phpdoc. quận. xml theo mặc định). Vui lòng tham khảo tài liệu để xem định dạng và các tùy chọn được hỗ trợ

bản dựng hàng đêm

PhpDocumentor không có bản phát hành hàng đêm. Tuy nhiên, trong mỗi đường ống, một vật phẩm phar được xây dựng. Nếu bạn muốn kiểm tra phiên bản mới nhất của phpDocumentor, hãy xem phần hành động của kho lưu trữ này. Mỗi quy trình công việc Đảm bảo chất lượng thành công đều có phần Phần mềm tạo tác ở dưới cùng với phần tạo tác phar được tạo

Làm cách nào để cài đặt phpDocumentor?

phpDocumentor là gì?

Làm thế nào để viết PHPDoc?

Tại sao bạn phải sử dụng cú pháp PHPDoc để viết mã tài liệu?