microsoft / microsoft/vscode-cpptools
Full doxygen docs formatting listing each command
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 6.2k
- Fork
- 1.7k
- Merge medio
- 14h 46m
- PR unite (30g)
- 61
Descrizione
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:

or fully showing each doxygen command with no formatting at all, like this:

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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Usate l'impostazione C_Cpp.simplifyStructuredComments come punto di ingresso e tracciate il modo in cui i commenti doxygen C/C++ vengono visualizzati negli hover dei metodi. Esaminate il comportamento semplificato e non semplificato esistente prima di decidere come dovrebbe funzionare una terza modalità formattata. Il lavoro è completo quando viene mostrato il contenuto completo dei comandi doxygen, preservando la presentazione formattata esistente, con la validazione effettuata usando commenti C/C++ rappresentativi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- c, cpp, typescript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100