microsoft / microsoft/vscode-cpptools
Doxygen comment generates "@param" for function with "void" parameter
Abierto
Nadie ha tomado este issue todavía.
bug
Feature: Doc comments
Language Service
Visual Studio
- Lenguaje dominante
- TypeScript
- Estrellas
- 6.2k
- Forks
- 1.7k
- Merge medio
- 14 h 46 min
- PR fusionados (30 d)
- 61
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el problema con el ejemplo de C++ proporcionado y el comando "Generate Doxygen Comment". Rastree el punto de entrada de la generación de comentarios y verifique después que una función declarada con void no produzca ninguna línea @param, manteniendo las salidas @brief y @return.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp, typescript
- Área
- devtools
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 52/100