phpDocumentor / phpDocumentor/ReflectionDocBlock

Support Annotation-style tags

Aperta
#199 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
PHP
Stelle
9.4k
Fork
137
Merge medio
4g 2h
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo questo issue e l’issue 2081 di phpDocumentor collegata per chiarire la sintassi prevista dei tag in stile Annotation e come dovrebbe differire dalle descrizioni in Markdown. Individua quindi i punti di ingresso per il parsing dei tag e la gestione delle descrizioni in ReflectionDocBlock; il lavoro è completato quando l’annotazione di esempio viene trattata come un first-class tag senza essere analizzata come parte della descrizione, con copertura per il nuovo comportamento.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
php
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.