phpDocumentor / phpDocumentor/ReflectionDocBlock

Support Annotation-style tags

Ouverte
#199 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
PHP
Étoiles
9.4k
Forks
137
Merge moyen
4 j 2 h
PR mergées (30 j)
1

Description

Tags like @Route("/anonymization_preset", name="anonymization_preset_") show the part between parenthesis as part of the description. It would be more convenient to make this a first-class citizen as now this conflicts with the rule that descriptions may be parsed as Markdown documents.

See https://github.com/phpDocumentor/phpDocumentor/issues/2081 for more information

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire cet issue ainsi que l’issue 2081 de phpDocumentor qui lui est liée afin de clarifier la syntaxe prévue des tags de style Annotation et la manière dont elle doit différer des descriptions Markdown. Repérez ensuite les points d’entrée du parsing des tags et de la gestion des descriptions dans ReflectionDocBlock ; le travail est considéré comme terminé lorsque l’annotation d’exemple est traitée comme un first-class tag sans être parsée comme faisant partie de la description, avec une couverture du nouveau comportement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
php
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.