Bất cứ ai có thể cho tôi biết cách xác định đúng không gian tên php trong cú pháp phpDoc là gì? Hoặc, là @package không được chấp nhận trong phpDoc, vì không gian tên nhiều hơn hoặc ít hơn xác định một gói?Xác định các không gian tên trong cú pháp phpDoc
Nếu không có, có cách nào phổ biến để ghi lại không gian tên tài liệu đang ở trong đó không?
phpDoc không có khái niệm về không gian tên nhưng bạn có thể (và có lẽ nên) sử dụng @package cho nó.
Bạn có thể xem phplint documentation để xem cách chúng định dạng không gian tên.
@package Nên được sử dụng trong mọi docblock của mọi tệp trong dự án của bạn, bạn cũng có thể sử dụng @subpackage. @package không được chấp nhận và sẽ là cách chính xác để xác định không gian tên của bạn.
Cảm ơn bạn, @subpackage có thể được sử dụng, tuy nhiên điều này không giải quyết vấn đề của tôi. +1 –
Bạn có thể xem DocBlox; đây là Trình tạo tài liệu API hỗ trợ không gian tên.
Và để trả lời rõ ràng hơn câu hỏi của bạn: như tôi đã gặp phải là các gói được coi là Không được chấp nhận do phát minh ra Không gian tên. Nếu bạn đọc đặc tả PSR-0, bạn sẽ thấy rằng nó cố gắng cung cấp Gói như phần thứ hai của không gian tên; đầu tiên là nhà cung cấp.
Các tài liệu PHPDoc nói:
Thẻ @package có thể được sử dụng như một đối tác hoặc bổ sung Namespaces. Không gian tên cung cấp một phân khu chức năng của các yếu tố cấu trúc trong đó thẻ @package có thể cung cấp phân mục hợp lý trong cách thức mà các phần tử có thể được nhóm lại với một hệ thống phân cấp khác.
Nếu, trên bảng, cả hai phân mục hợp lý và chức năng là bằng nhau KHÔNG ĐƯỢC ĐỀ XUẤT sử dụng thẻ @package, để tránh chi phí bảo trì .
https://www.phpdoc.org/docs/latest/references/phpdoc/tags/package.html
Cảm ơn bạn đã tham khảo một thư viện hiện có sử dụng định dạng không gian tên trong tài liệu của họ. Tôi không thể tìm thấy một, chắc chắn hữu ích! –
[Hướng dẫn sử dụng PHPdoc] (http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.pkg.html) cũng là một tài nguyên tốt –
Vì câu trả lời này đã di chuyển một chút. phpDoc hiện nay sử dụng rất nhiều khái niệm về không gian tên nhưng tài liệu phpDoc không định nghĩa nó vì nó là một khái niệm ngôn ngữ PHP có thể kiểm soát được trong PHP 5.3. Tài liệu phpDoc bây giờ khuyến nghị sử dụng các không gian tên trên @package, nơi mà mục đích là có cùng một hệ thống phân cấp trong cả hai, như thường là trường hợp. – ClearCrescendo