`A2-7-3`: Certain `using` declarations are wrongly considered undocumented.

Offen

#398 erstellt am 05.10.2023 2 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

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

Rechercherichtung

Beginnen Sie mit der A2-7-3-Regel und reproduzieren Sie das bereitgestellte C++-Beispiel. Konzentrieren Sie sich dabei auf die dokumentierte using-Deklaration innerhalb des Funktionstemplates. Verfolgen Sie, wie die Regel nebenstehende Dokumentation erkennt, und überprüfen Sie, dass die Deklaration nicht mehr als undokumentiert gemeldet wird, während das Beispiel weiterhin durch die Tests der Regel abgedeckt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Difficulty-High false positive/false negative Impact-Low Standard-AUTOSAR user-report

Affected rules

A2-7-3

Description

using declarations within functions do not detect colocated documentation.

Example

#include <type_traits>
template <typename Integer> void foo(Integer i) {
  /// documentation
  using unsigned_integer = std::make_unsigned_t<Integer>;
}

void test() {
  foo<int>(1);
  foo<unsigned int>(1);
}

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