microsoft / microsoft/vscode-cpptools

Add support for doxygen `\copydoc` command

Offen
#5,718 11 Kommentare 86 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Feature Request Feature: Doc comments Language Service Visual Studio
Vorherrschende Sprache
TypeScript
Sterne
6.2k
Forks
1.7k
Ø Merge
14 Std. 46 Min.
Gemergte PRs (30 T.)
61

Beschreibung

We sometimes use the \copydoc to not duplicate documentation when it is not needed. It would be great if the documentation of the mentioned symbol would be used for the tooltip.

Originally posted by @ben-edna in https://github.com/microsoft/vscode-cpptools/issues/658#issuecomment-652865472

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 mit dem Lesen der Doxygen-Dokumentation zum Befehl \copydoc und verfolge, wie die Erweiterung die Dokumentation für die Tooltip-Anzeige extrahiert. Identifiziere die vorhandenen Einstiegspunkte für das Parsen der Dokumentation und für Tooltips und überprüfe anschließend, dass ein Symbol, das \copydoc verwendet, die Dokumentation des referenzierten Symbols in seinem Tooltip anzeigt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

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