Làm cách nào để ghi lại các hằng số lớp cho phpDoc? Tôi đã đọc hướng dẫn nhưng tôi không thể tìm thấy bất cứ điều gì về họ.phpDoc lớp hằng số tài liệu
Trả lời
Tôi khá chắc chắn rằng bạn có thể sử dụng @const
, mặc dù tôi không thể tìm thấy bất kỳ tài liệu tiếng Anh nào. Có một ví dụ của Đức here. Nó hiển thị các câu lệnh define
thay vì các hằng số lớp, nhưng cú pháp IIRC giống nhau.
Tôi không biết lý do tại sao nó không được tài liệu nhưng nó có vẻ làm việc, cảm ơn ... – mck89
Xem xét tốt hơn về tài liệu '' const' là ở đây: http://stackoverflow.com/a/18446766/367456 - nó cũng giải thích rằng không có điều như vậy tồn tại. – hakre
Nên sử dụng '@ var' theo câu trả lời này: http://stackoverflow.com/a/27772200/2053165 – Leith
Hằng số chỉ cần một tài liệu có chứa mô tả. Không cần thẻ cụ thể. Trình phân tích mã tự xác định các hằng số và hiển thị chúng như trong tài liệu được tạo ra (here's an example).
- 1. Tài liệu Nhận/Đăng Tham số với Doxygen hoặc PHPDoc
- 2. Tài liệu thừa kế nhiều PHP với PhpDoc
- 3. Trình tạo tài liệu PHPDoc trong hoặc ngoài Eclipse?
- 4. Tham số tùy chọn PHPDoc
- 5. Hằng số hoặc biến lớp trong ruby?
- 6. Có một lớp "hằng số" trong JSF
- 7. Lớp PHP chỉ chứa các hằng số
- 8. Xác định hằng số lớp trong PHP
- 9. Mẫu PHPDoc
- 10. hằng số chuỗi tĩnh trong lớp vs không gian tên cho hằng số [C++]
- 11. Hằng số cho các loại tài nguyên trong Android
- 12. hai hay nhiều kiểu dữ liệu trong PHPDoc @ param
- 13. Phương thức lớp vs hằng số trong Ruby/Rails
- 14. Uninitialized hằng số AssetSync
- 15. Singletons và hằng số
- 16. Sử dụng biến lớp làm hằng số trong Scala
- 17. cách chia sẻ hằng số (enums) giữa các lớp?
- 18. Thuộc tính tệp vs Lớp hằng số trong Java
- 19. Hằng số động trong PHP?
- 20. Cách tốt nhất để xác định hằng số trong android, lớp tĩnh, giao diện hoặc tài nguyên xml là gì?
- 21. Scala Số init với hằng số 0
- 22. Cách tạo hằng số trong javascript
- 23. PHPDoc nội tuyến {@link} (và Netbeans)
- 24. buộc các lớp con bao gồm hằng số trong lớp java trừu tượng
- 25. Hằng số tĩnh trong C#
- 26. Quy ước đặt tên cho lớp hằng số trong C#: số nhiều hoặc số ít?
- 27. JavaScript event.keyCode hằng số
- 28. C# số hằng
- 29. Hằng số trong ánh xạ dozer
- 30. Liệu doxygen có sử dụng tài liệu lớp cơ sở nếu một lớp con không cung cấp tài liệu riêng?
sử dụng '@ var' là đúng cách để làm điều đó, hãy xem https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var – m13r