Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add support for parsing docs for single constants

Đang mở
  • Có gì không ổn?
#204 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
25/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
documentation, tooling

Hướng nghiên cứu

Bắt đầu với PR #203 và nhánh xử lý hằng số hiện có của parser. Kiểm tra cách PR tích hợp các hằng số vào một post type và lấy tài liệu của chúng; hoàn thành có nghĩa là các mô tả được lưu trữ, còn việc chỉnh sửa và hỗ trợ hiển thị post type nằm ngoài phạm vi. Lưu ý rằng phpDocumentor vẫn chưa hỗ trợ DocBlock templates.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement has PR

The parser already technically supports parsing constants, but the attached PR hooks them up to a new post type and retrieves the associated documentation. We can add post type / editing / display support at a later time in the wporg-developer theme, but it would be nice to be actually storing the descriptions somewhere.

PR: #203

It should be noted that parsing DocBlock template support is not yet available in phpDocumentor, which means core WordPress is kind of out of luck with the current state of constants documented in wp-config.php. Templates are the ability to document multiple elements at the same time, e.g.

/**#@+
 * DocBlock Template example: One summary for all.
 *
 * One description for all.
 *
 * @since 2.6.0
 */
define('AUTH_KEY',         '...');
define('SECURE_AUTH_KEY',  '...');
define('LOGGED_IN_KEY',    '...');
define('NONCE_KEY',        '...');
define('AUTH_SALT',        '...');
define('SECURE_AUTH_SALT', '...');
define('LOGGED_IN_SALT',   '...');
define('NONCE_SALT',       '...');

/**#@-*/
Ngôn ngữ chính
PHP
Star
239
Fork
81
Merge trung bình
1 ngày 22 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của WordPress/phpdoc-parser

Tất cả issue của WordPress/phpdoc-parser

Issue tương tự

Thêm issue về PHP

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.