Forstå strukturerede fund

AI Diff Review giver strukturerede, organiserede fund, der gør det nemt at forstå, hvilke problemer der blev fundet, og hvordan de skal håndteres. I modsætning til generiske kodegennemgangskommentarer er disse fund kategoriserede og prioriterede, hvilket hjælper dig med at fokusere på det, der er vigtigst.

Fundkategorier

Fund er organiseret i seks hovedkategorier, hver med et specifikt formål:

Kritiske problemer

Dette er alvorlige problemer, der kan bryde funktionalitet eller forårsage betydelige problemer i produktion. Eksempler inkluderer:

  • Null pointer-undtagelser, der venter på at ske
  • Logikfejl, der kan forårsage forkert opførsel
  • Manglende fejlhåndtering, der kan crashe applikationen
  • Breaking changes til API'er eller grænseflader

Alvorlighedsniveauer: KRITISK, ADVARSEL, INFO

Sikkerhedsbekymringer

Potentielle sikkerhedssårbarheder og risici, der kan udnyttes. Dette er en af de vigtigste kategorier, da sikkerhedsproblemer kan have alvorlige konsekvenser. Eksempler inkluderer:

  • SQL-injektionssårbarheder
  • Cross-site scripting (XSS)-risici
  • Eksponerede hemligheder eller legitimationsoplysninger
  • Usikker godkendelse eller autorisering
  • Usikker datalagring eller transmission

Alvorlighedsniveauer: KRITISK, ADVARSEL, INFO

KRITISKE sikkerhedsproblemer udløser altid commit-portblokering, når porten er aktiveret.

Kodekvalitet

Problemer relateret til vedligeholdelighed, læsbarhed og overholdelse af bedste praksis. Selvom disse måske ikke forårsager umiddelbare problemer, kan de gøre kode sværere at vedligeholde over tid. Eksempler inkluderer:

  • Kodeduplikering
  • Komplekse funktioner, der bør refaktoreres
  • Inkonsistente navnekonventioner
  • Manglende dokumentation
  • Dårlige fejlmeddelelser

Alvorlighedsniveauer: ADVARSEL, INFO

Ydeevne-noter

Muligheder for at forbedre effektivitet og optimering. Disse fund hjælper dig med at skrive hurtigere, mere ressource-effektiv kode. Eksempler inkluderer:

  • Ineffektive algoritmer eller datastrukturer
  • Unødvendige databaseforespørgsler
  • Hukommelseslækager eller ressource-lækager
  • Ineffektiv strengkonkatenering
  • Manglende caching-muligheder

Alvorlighedsniveauer: ADVARSEL, INFO

Testanbefalinger

Forslag til at forbedre testdækning og testkvalitet. Disse hjælper med at sikre, at din kode er godt testet og pålidelig. Eksempler inkluderer:

  • Manglende testtilfælde for ny funktionalitet
  • Edge cases, der bør testes
  • Testkvalitetsforbedringer
  • Integrationstestanbefalinger

Alvorlighedsniveauer: ADVARSEL, INFO

Forslag

Generelle forbedringer og forbedringer, der kan gøre din kode bedre. Disse er ofte valgfrie men kan forbedre kodekvaliteten. Eksempler inkluderer:

  • Brug af mere moderne sprogfunktioner
  • Forenkling af komplekse udtryk
  • Bedre variabelnavngivning
  • Kodeorganisationsforbedringer

Alvorlighedsniveauer: ADVARSEL, INFO

Alvorlighedsniveauer

Hvert fund har et alvorlighedsniveau, der indikerer dets betydning:

KRITISK

Dette er alvorlige problemer, der bør adresseres med det samme. De repræsenterer reelle risici for funktionalitet, sikkerhed eller dataintegritet. KRITISKE fund i Sikkerhedsbekymringer eller Kritiske problemer kan blokere commits, når porten er aktiveret.

ADVARSEL

Dette er vigtige problemer, der bør adresseres snart. Selvom de ikke er umiddelbart kritiske, repræsenterer de problemer, der kan forårsage problemer i fremtiden eller indikere områder, der har brug for opmærksomhed.

INFO

Dette er forslag og mindre problemer. De er værd at overveje, men ikke presserende. INFO-fund bidrager mindre til commit-portscoring og er ofte valgfrie forbedringer.

Forstå funddetaljer

Hvert fund inkluderer:

  • Fil: Filen, hvor problemet blev fundet
  • Linje: Det specifikke linjenummer (hvis relevant)
  • Beskrivelse: Detaljeret forklaring af problemet og hvorfor det er vigtigt
  • Type: Hvilken kategori fundet tilhører
  • Alvorlighedsgrad: Hvor alvorligt problemet er

Bruge fund effektivt

Prioritere efter alvorlighedsgrad

Start med at adressere KRITISKE fund, derefter ADVARSEL, derefter INFO. Dette sikrer, at du retter de vigtigste problemer først.

Fokusere på sikkerhed

Sikkerhedsbekymringer bør altid tages alvorligt, selvom de er markeret som ADVARSEL eller INFO. Sikkerhedsproblemer kan have alvorlige konsekvenser og bør adresseres hurtigt.

Bruge kontekst

Klik på fund for at navigere til den specifikke kode. At forstå konteksten hjælper dig med at træffe informerede beslutninger om, om og hvordan hvert problem skal adresseres.

Filtrere og søge

Brug filtrerings- og søgefunktionerne for at fokusere på specifikke typer problemer. Filtrer for eksempel kun Sikkerhedsbekymringer, når du laver en sikkerhedsfokuseret gennemgang.

Lære af mønstre

Hvis du ser samme type fund gentagne gange, kan det indikere et mønster i din kodbase, der skal adresseres. Brug denne indsigt til at forbedre dine kodningsmetoder.

Falske positive

Som ethvert automatiseret værktøj kan AI Diff Review lejlighedsvis flagge ting, der faktisk ikke er problemer. Når du støder på et falskt positivt:

  • Overvej, om fundet har værdi, selvom det ikke er kritisk
  • Brug din dømmekraft—du kender din kodbase bedst
  • Hvis det er et mønster, overvej, om din kode kan være klarere
  • Husk, at AI'en forsøger at hjælpe, selvom den ikke altid har ret

Konklusion

Strukturerede fund gør det nemt at forstå og handle på AI Diff Reviews analyse. Ved at forstå kategorierne og alvorlighedsniveauerne kan du prioritere dine indsatser og fokusere på det, der er vigtigst.

Husk, at fund er forslag baseret på bedste praksis og almindelige mønstre. Brug dem som vejledning, men anvend altid din egen dømmekraft baseret på din specifikke kontekst og krav.

Målet er at forbedre kodekvaliteten over tid, ikke at opnå perfektion med det samme. Adresser kritiske problemer først, arbejd derefter med advarsler og forslag, når tiden tillader det.

Klar til at begynde at forbedre din kodekvalitet? Installer AI Diff Review og se, hvilke indsigter det kan give for din kodbase.