jasny / jasny/phpdoc-parser

Example of how to render classes PHPDoc

Đang mở
#39 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
41
Fork
8
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Hey Jasny,

Not really an issue, but wanted to share some code for those looking to get phpdoc for classes in an array.

This does get the default properties and methods available in the class provided. Could definitely use some tweaking

I didn't see any example on your site, so decided I may be able to figure it out. Now I'm seeing its going to take a lot longer than I expected to create markdown files from some classes with PHPDoc comments, but I might circle back around to it later.

use Jasny\PhpdocParser\PhpdocParser;
use Jasny\PhpdocParser\Set\PhpDocumentor;
use Jasny\PhpdocParser\Tag\Summery;

include 'vendor/autoload.php';

$cls = new ReflectionClass('Jasny\PhpdocParser\PhpdocParser');
$doc = $cls->getDocComment();
$tags = PhpDocumentor::tags()->with([new Summery()]);
$parser = new PhpdocParser($tags);

$meta = $parser->parse($doc);

$foundProperties = $cls->getDefaultProperties();

$getMethods = $cls->getMethods();
$foundMethods = [];
foreach($getMethods as $methodAry){
	$docMethod = $cls->getMethod($methodAry->name)->getDocComment();
	$foundMethods[$methodAry->name] = $parser->parse($docMethod);
}

echo print_r($meta,1).PHP_EOL
	.print_r($foundProperties,1).PHP_EOL
	.print_r($foundMethods,1).PHP_EOL;

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

  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

Xem lại ví dụ PHP dùng chung, đặc biệt là phần thiết lập ReflectionClass và PhpdocParser, cùng với các ví dụ hiện có trên site của dự án. Xác nhận liệu có cần một ví dụ về tài liệu hay không và các ví dụ được duy trì ở đâu; công việc được xem là hoàn tất khi có một ví dụ đã được xem xét và duy trì, thể hiện metadata của class và PHPDoc đã được phân tích.

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ài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.