Dieser Artikel bietet Definitionen für die von Code Quality verwendeten Metriken und Punktzahlen.
Sie können die regelbasierten Ergebnisse für Ihr Repository auf Ihrer Security and quality Registerkarte in der Standardergebnisse Registerkarte unter " Codequalität" sehen.
Metrikdefinitionen
Die folgende Tabelle enthält Definitionen für jede Metrik, die für Ihr Repository gemeldet wird.
| Metric | Definition | Beispielergebnisse |
|---|---|---|
| Reliability | Bewerten Sie, ob der Code seine beabsichtigte Funktion korrekt, vorhersehbar und konsistent ausführt. Zuverlässiger Code ist frei von Bugs, behandelt Ausnahmen sicher und funktioniert unter normalen Bedingungen sowie Randbedingungen wie erwartet. | Probleme mit Leistung, Parallelität, Fehlerbehandlung, Korrektheit |
| Wartbarkeit | Bewerten Sie, wie einfach es ist, den Code im Laufe der Zeit zu verstehen, zu ändern und zu erweitern. Wartbarer Code folgt bewährten Methoden, vermeidet unnötige Komplexität und ist organisiert, um zukünftige Änderungen und Zusammenarbeit zu erleichtern. | Nicht verwendeter/toter Code, Lesbarkeit, Komplexität, widersprüchliche Benennung, schlechte Trennung von Bedenken |
Schweregrade
Schweregrade werden verwendet, um die potenzielle Auswirkung oder Dringlichkeit eines Codequalitätsbefundes anzugeben. Sie helfen Benutzern, Abhilfemaßnahmen zu priorisieren und Risiken an die Projektbeteiligten zu kommunizieren. Der Schweregrad wird durch die Regel bestimmt, die das Problem festgestellt hat, gemäß den Konventionen von CodeQL und den Branchenstandards.
| Severity | Definition |
|---|---|
| Error | Gibt ein Problem mit hohem Schweregrad an, das wahrscheinlich Bugs, Ausfälle oder erhebliche Wartungsrisiken verursacht. |
| Warnung | Gibt ein Problem mit mittlerem Schweregrad an, das sich auf die Codequalität oder Zuverlässigkeit auswirken kann, aber nicht sofort kritisch ist. |
| Hinweis | Gibt ein Problem mit geringem Schweregrad, geringfügige Verbesserung oder Empfehlung an. Diese Ergebnisse sind nützlich für die fortlaufende Codeintegrität und -wartung. |
Definitionen der Bewertungen
Diese Werte werden verwendet, um die allgemeine Zuverlässigkeit und Wartbarkeit eines Repositorys auf Grundlage des Schweregrads regelbasierter Ergebnisse zusammenzufassen, die bei CodeQL-Scans des vollständigen Standard-Branches gefunden wurden:
| Punktzahlen | Definition | Kriterien (basierend auf Ergebnissen) |
|---|---|---|
| Sehr gut! | Codebase veranschaulicht bewährte Methoden für Zuverlässigkeit und Wartung. | Es wurden keine Codequalitätsfeststellungen gefunden. |
| Gute | Codebase hat Probleme mit geringem Schweregrad oder kleinere Verbesserungen werden vorgeschlagen. | ≥1 "Anmerkung"-Ebenenfund |
| Fair | Codebase hat Probleme mit mittlerem Schweregrad, die sich auf die Qualität auswirken können, aber nicht kritisch sind. | ≥1 "Warnstufe"-Hinweis |
| Schlecht | Codebase hat Probleme mit hohem Schweregrad, einschließlich Fehler oder größere Wartungsrisiken. | ≥1 Fehlerniveau-Ergebnis |
Codeabdeckung
Einzelheiten dazu, wie Code Quality die Codeabdeckung misst und meldet, finden Sie unter Code coverage reference.