phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- PHP
- Star
- 9.4k
- Fork
- 137
- Merge trung bình
- 4 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
In issue https://github.com/phpDocumentor/phpDocumentor/issues/3378, there was some confusion because the Author tag does not support a description. When the StandardTagFactory encounters a situation where an InvalidTag is generated, it would be nice if it could ask the Tag class what the expected format is and a link to the documentation; and include that in the InvalidTag so that phpDocumentor can provide better error messages in the error report
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách đọc StandardTagFactory, InvalidTag và hành vi của lớp Tag được mô tả trong issue, sau đó xem lại phần thảo luận liên quan trong issue 3378. Công việc được xem là hoàn tất khi các instance của InvalidTag bao gồm định dạng tag dự kiến và liên kết đến tài liệu phpDocumentor liên quan, để các báo cáo lỗi cung cấp hướng dẫn rõ ràng hơn.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- php
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100