Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

`A2-7-3`: template function prototypes with comments are not correctly detected

Abierto
#528 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
cpp
Área
tooling

Línea de trabajo

Comienza con la regla cpp/autosar/undocumented-user-defined-type y reproduce el ejemplo proporcionado de TemplateFunction. Inspecciona cómo se tratan los elementos comentados para los prototipos de funciones plantilla, especialmente la condición c.getCommentedElement() = de; se considera terminado cuando MyFunction, que está documentada, ya no se marca incorrectamente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Difficulty-Medium false positive/false negative Impact-High Phase III Standard-AUTOSAR user-report
Affected rules
  • cpp/autosar/undocumented-user-defined-type
Description

The query incorrect flags the function MyFunction.

Example
/// @brief MyFunction.
/// @tparam MyType template parameter.
/// @param  Parameter.
/// @return Return type.
template <typename MyType> auto MyFunction(MyType) -> MyType;

The condition c.getCommentedElement() = de doesn't hold for TemplateFunction.

Lenguaje dominante
CodeQL
Estrellas
227
Forks
82
Merge medio
6 d 7 h
PR fusionados (30 d)
9

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/codeql-coding-standards

Todos los issues de github/codeql-coding-standards

Issues similares

Más issues de DevTools

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.