jasny / jasny/phpdoc-parser

Example of how to render classes PHPDoc

Abierto
#39 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
PHP
Estrellas
41
Forks
8
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

```php
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;
```

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Revisa el ejemplo compartido de PHP, especialmente su configuración de ReflectionClass y PhpdocParser, junto con los ejemplos existentes del sitio del proyecto. Confirma si se desea un ejemplo de documentación y dónde se mantienen los ejemplos; se considerará completado cuando haya un ejemplo revisado y mantenido que muestre metadatos de clase y PHPDoc analizado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
php
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.