phpDocumentor / phpDocumentor/ReflectionDocBlock

Add @template & Conditional return types

Offen
#372 10 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

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

https://phpstan.org/writing-php-code/phpdoc-types#conditional-return-types

@template T of int|array
@return (T is int ? static : array)

I am not sure that you support psalm-types too

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die verlinkte Dokumentation zu bedingten Rückgabetypen von PHPStan zu lesen, und untersuche, wie ReflectionDocBlock derzeit @template- und @return-Annotationen verarbeitet. Ermittle, ob die gezeigte Syntax und die Typen im Psalm-Stil unterstützt werden, und verwende anschließend die vorhandenen Tests des Projekts zur Typverarbeitung, um das erwartete Verhalten zu definieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
php
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.