support @internal tag
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- php
- Lĩnh vực
- cli, documentation
Hướng nghiên cứu
Bắt đầu bằng cách lần theo các lệnh wp-cli tạo bài đăng từ các chú thích PHPDoc và xác định nơi các phần tử @internal được xử lý. Triển khai việc ẩn theo mặc định được yêu cầu và hành vi của cờ ghi đè, sau đó xác minh rằng các hàm và lớp nội bộ bị loại trừ trừ khi cờ được truyền vào.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
I'd like to update the wp-cli commands to not create posts for functions/classes/etc marked as @internal unless an override flag is passed to wp-cli.
When generating documentation from PHPDoc comments it is RECOMMENDED to hide the associated element unless the user has explicitly indicated that internal elements should be included.
An additional use of @internal is to add internal comments or additional description text inline to the Long Description. This may be done, for example, to withhold certain business-critical or confusing information when generating documentation from the source code of this piece of software.
https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#78-internal
- Ngôn ngữ chính
- PHP
- Star
- 239
- Fork
- 81
- Merge trung bình
- 16 giờ 29 phút
- Pull request đã merge (30 ngày)
- 8
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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.
Issue khác của WordPress/phpdoc-parser
-
Include constants in exports Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
WordPress/phpdoc-parser#269 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 64/100
WordPress/phpdoc-parser#268 · 1 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
WordPress/phpdoc-parser#254 ·
-
Compatibility updates required Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
WordPress/phpdoc-parser#246 · 9 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
WordPress/phpdoc-parser#235 · 1 bình luận ·
Tất cả issue của WordPress/phpdoc-parser
Issue tương tự
-
Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
Automattic/safe-publish#594 ·
-
HttpClient
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
symfony/symfony-docs#23092 ·
-
sync-en
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
-
sync-en
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
-
Перевод устарел
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100