Example of how to render classes PHPDoc
Personne n'a encore pris cette issue.
- Langage dominant
- PHP
- Étoiles
- 41
- Forks
- 8
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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;
```
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez l’exemple PHP partagé, en particulier sa configuration de ReflectionClass et PhpdocParser, ainsi que les exemples existants du site du projet. Confirmez si un exemple de documentation est souhaité et où les exemples sont maintenus ; le travail sera considéré comme terminé lorsqu’un exemple révisé et maintenu montrera les métadonnées de classe et le PHPDoc analysé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- php
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100