phpDocumentor / phpDocumentor/ReflectionDocBlock

Support Annotation-style tags

Đang mở
#199 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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ả

Tags like @Route("/anonymization_preset", name="anonymization_preset_") show the part between parenthesis as part of the description. It would be more convenient to make this a first-class citizen as now this conflicts with the rule that descriptions may be parsed as Markdown documents.

See https://github.com/phpDocumentor/phpDocumentor/issues/2081 for more information

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. 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 issue này và issue 2081 của phpDocumentor được liên kết để làm rõ cú pháp tag theo kiểu Annotation dự kiến và cách nó cần khác với các mô tả Markdown. Sau đó, xác định các điểm đầu vào để phân tích tag và xử lý mô tả trong ReflectionDocBlock; công việc được xem là hoàn tất khi annotation ví dụ được xử lý như một first-class tag mà không bị phân tích như một phần của mô tả, với độ bao phủ cho hành vi mới.

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ó
4/5
Thời gian dự kiến
3-5 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
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.