microsoft / microsoft/vscode-cpptools

Doxygen monospaced comments that preserve whitespace

Offen
#9,422 2 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement 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

Feature Request

I don't know if this is something that Doxygen supports but I find it occasionally useful to have ASCII ART in my comments to act as a visual aid. This can be done with fenced markdown support as well, is there something you can do to just render something from a comment in a preformatted monospaced font? I've tried markdown (which I understand has been disabled) and HTML but it is also being ignored. I'm no expert on Doxygen maybe there's a simple workaround?

image

The above is rendered as below.

image

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

Der Issue nennt keine Datei, keinen Test und keinen Einstiegspunkt; beginne damit, den gezeigten Doxygen-Kommentar in der Erweiterung zu reproduzieren. Vergleiche die gerenderte Ausgabe mit den angehängten Beispielen und stelle fest, ob vorformatierte, Leerzeichen bewahrende monospaced Ausgabe unterstützt wird. Erledigt ist die Aufgabe, wenn die erwartete Darstellung oder ein dokumentierter Workaround feststeht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
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.