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

Offen

#528 erstellt am 09.2.2024 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: cpp
Bereich: tooling

Rechercherichtung

Beginne mit der Regel cpp/autosar/undocumented-user-defined-type und reproduziere das bereitgestellte TemplateFunction-Beispiel. Untersuche, wie kommentierte Elemente für Prototypen von Template-Funktionen behandelt werden, insbesondere die Bedingung c.getCommentedElement() = de; als erledigt gilt die Aufgabe, wenn MyFunction mit Dokumentation nicht mehr fälschlicherweise beanstandet wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache: CodeQL
Sterne: 227
Forks: 82
Ø Merge: 6 T. 7 Std.
Gemergte PRs (30 T.): 9

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/codeql-coding-standards

`RULE-10-0-1`: Structured bindings should not be reported as violations Offen

false positive/false negative Stardard-MISRA-C++

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

github/codeql-coding-standards#1172 · Erstellt am 05.8.2026
`RULE-10-4`: False negatives as rule does not currently consider ternaries Offen

Difficulty-Low false positive/false negative false-negative Impact-Low Standard-MISRA-C

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

github/codeql-coding-standards#821 · Erstellt am 12.12.2024
`EXP39-C`: False positives related to compatible types, harmless casts Offen

Difficulty-Medium false positive/false negative false-positive Impact-Medium Standard-CERT-C

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100

github/codeql-coding-standards#1200 · Erstellt am 20.9.2026
`RULE-0-0-1`: "unreachable statement" false positives due to over-pruning of the control-flow graph Offen

false positive/false negative

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100

github/codeql-coding-standards#1190 · Erstellt am 28.8.2026
`RULE-0-1-1`: Findings should be suppressed for [[maybe_unused]] initialization Offen

false positive/false negative

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100

github/codeql-coding-standards#1175 · Erstellt am 20.8.2026

Alle Issues in github/codeql-coding-standards