microsoft / microsoft/vscode-cpptools

Doxygen monospaced comments that preserve whitespace

Aperta
#9,422 2 commenti 5 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement Feature: Doc comments Language Service
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

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

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

L'issue non indica alcun file, test o punto di ingresso; inizia riproducendo il commento Doxygen mostrato nell'estensione. Confronta l'output renderizzato con gli esempi allegati e determina se è supportato un output monospaziato preformattato che preservi gli spazi bianchi. Il lavoro è concluso quando è stato stabilito il rendering previsto o un workaround documentato.

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

Valutazione

Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.