microsoft / microsoft/vscode-cpptools
Doxygen comment generates "@param" for function with "void" parameter
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 6.2k
- Fork
- 1.7k
- Merge medio
- 14h 46m
- PR unite (30g)
- 61
Descrizione
Environment
- C/C++ Extension Version: 1.16.3
Bug Summary and Steps to Reproduce
Reported in issue https://github.com/microsoft/vscode-cpptools/issues/11282.
Bug Summary:
Dogyxen generation comment creates @param for a function with void in parameter list.
Sample code:
int my_function(void)
{
return 0;
}
Steps to reproduce:
- Use sample code.
- Right-click on
my_function - Select "Generate Doxygen Comment"
Actual result:
/// @brief
/// @param
/// @return
int my_function(void)
{
return 0;
}
Expected behavior:
/// @brief
/// @return
int my_function(void)
{
return 0;
}
Configuration and Logs
n/a
Other Extensions
No response
Additional context
No response
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
Riprodurre il problema con l'esempio C++ fornito e il comando "Generate Doxygen Comment". Tracciare il punto di ingresso della generazione dei commenti, quindi verificare che una funzione dichiarata con void non produca alcuna riga @param, mantenendo gli output @brief e @return.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp, typescript
- Ambito
- devtools
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 52/100