microsoft / microsoft/vscode-cpptools

Full doxygen docs formatting listing each command

Offen
#7,932 1 Kommentar 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Type: Feature Request

As of now, doxygen documentation in c/cpp headers is shown when hovering methods either in short form like with fancy formatted parameter list and stuff like so:
image
or fully showing each doxygen command with no formatting at all, like this:
image

Setting C_Cpp.simplifyStructuredComments in settings.json to true (former) or false (latter) controls this behaviour

Now, it would be nice to have a way to show full documentation of a method in a formatted way, showing each doxygen command (instead of cutting text abruptly before the next doxygen command) while retaining the fancy formatting, but as a third year computer engineering undergrad that has never touched a codebase that wasn't written by themselves I found the job of implementing it myself a bit overwhelming, so if you could consider either implementing this feature or pointing me in the right direction so that I can contribute and implement and push the feature myself that would be much appreciated.

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

Verwenden Sie die Einstellung C_Cpp.simplifyStructuredComments als Einstiegspunkt und verfolgen Sie, wie C/C++-doxygen-Kommentare in Methoden-Hovern dargestellt werden. Überprüfen Sie das bestehende vereinfachte und nicht vereinfachte Verhalten, bevor Sie entscheiden, wie ein dritter formatierter Modus funktionieren soll. Als abgeschlossen gilt die Aufgabe, wenn der vollständige Inhalt der doxygen-Befehle angezeigt wird und dabei die bestehende formatierte Darstellung erhalten bleibt, validiert anhand repräsentativer C/C++-Kommentare.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c, cpp, typescript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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