phpDocumentor / phpDocumentor/ReflectionDocBlock
Support Annotation-style tags
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 9.4k
- Forks
- 137
- Ø Merge
- 4 T. 2 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, diesen Issue und den verlinkten phpDocumentor-Issue 2081 zu lesen, um die beabsichtigte Annotation-style-Tag-Syntax und deren Unterschied zu Markdown-Beschreibungen zu klären. Suche dann die Einstiegspunkte für das Parsen von Tags und die Verarbeitung von Beschreibungen in ReflectionDocBlock. Als erledigt gilt die Aufgabe, wenn die Beispielannotation als first-class tag behandelt wird, ohne als Teil der Beschreibung geparst zu werden, und das neue Verhalten abgedeckt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100