microsoft / microsoft/vscode-cpptools
Doxygen comment generates "@param" for function with "void" parameter
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 6.2k
- Forks
- 1.7k
- Ø Merge
- 14 Std. 46 Min.
- Gemergte PRs (30 T.)
- 61
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Reproduzieren Sie das Problem mit dem bereitgestellten C++-Beispiel und dem Befehl "Generate Doxygen Comment". Verfolgen Sie den Einstiegspunkt der Kommentargenerierung und überprüfen Sie anschließend, dass eine mit void deklarierte Funktion keine @param-Zeile erzeugt, während die Ausgaben @brief und @return erhalten bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp, typescript
- Bereich
- devtools
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 52/100