microsoft / microsoft/vscode-cpptools

Support direction (or "['dir']") optional attribute of Doxygen \param

Aperta
#5,773 14 commenti 18 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Feature requested on Visual Studio at https://developercommunity.visualstudio.com/t/support-dir-optional-attribute-of-doxygen-param/1112281

Feature details:
This is a feature request to support parsing of the direction (or ‘[‘dir’]’) optional attribute of the Doxygen command \param '[‘dir’]'

Information about the direction or “dir” attribute:
https://www.doxygen.nl/manual/commands.html#cmdparam

Example:

/*!
 * Copies bytes from a source memory area to a destination memory area,
 * where both areas may not overlap.
 * @param[out] dest The memory area to copy to.
 * @param[in]  src  The memory area to copy from.
 * @param[in]  n    The number of bytes to copy
 */
void memcpy(void *dest, const void *src, size_t n);

If ‘[‘dir’]’ is supported, the hover info of the memcpy would show which param are [in] and which are [out].

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

Inizia individuando la gestione di Doxygen \param e il percorso delle informazioni al passaggio del mouse nell’estensione C/C++. Usa l’esempio fornito di [in] e [out] per tracciare l’attributo di direzione richiesto; il lavoro è completo quando le informazioni al passaggio del mouse identificano la direzione di ogni parametro.

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

Valutazione

Stack tecnologico
cpp, typescript
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.