Poročanje o kakovosti kode z Maven
Z izboljšanjem kakovosti kode programa se bo izboljšala tudi njegova robustnost in vzdržljivost . Ta priročnik vas bo naučil, kako ustvariti poročila o kakovosti kode za projekt Maven .
- Kako ustvariti spletno mesto projekta in poročila z Maven
- Vtičniki za analizo kode in poročanje za Maven
- Kako ustvariti poročila v Maven
- Kako si lahko ogledate poročila v aplikaciji Maven
- Vir XRef
- Testni vir Xref
- Dokumenti Java
- Preizkusite dokumente Java
- Poročilo o zanesljivosti
- Varno poročilo
- Checkstyle
- CPD
- PMD
- FindBugs
- Sestavite svoja poročila s programom SonarQube
Kako ustvariti spletno mesto projekta in poročila z Maven
Maven vam omogoča ustvarjanje strani HTML, ki opisuje vaš projekt. Uporabite lahkomvn siteukaz za ustvarjanje mesta projekta.
Ko končate, odprite datoteko target / site / index.html, da si ogledate spletno mesto:
Mesto projekta bo običajno vsebovalo tehnične informacije o arhitekturi projekta (odvisnosti, vtičniki…); morate ga obogatiti s podatki, ki jih generirajo vtičniki Mavenovih poročil (kot so definirani v konfiguracijski datoteki projekta ).
Vtičniki za analizo kode in poročanje za Maven
Spodaj je izvleček, ki ga lahko vključite v konfiguracijsko datoteko ( pom.xml ). Ima nekaj samostojnih vtičnikov za analizo kode in poročanje. Vsak vtičnik bo ustvaril posebno poročilo o mestu projekta.org.apache.maven.plugins maven-failsafe-plugin 2.19.1 integracija-test preverjanje org.apache.maven.plugins maven-jxr-plugin 2.5 org.apache.maven.plugins maven-javadoc-plugin 2.10.3 -Xdoclint: ni org.apache.maven.plugins maven-surefire-report-plugin 2.19.1 org.apache.maven.plugins maven-checkstyle-plugin 2.17 org.apache.maven.plugins maven-pmd-plugin /android.xml nabor pravil / java / basic.xml rulesets / java / braces.xml nabor pravil / java / clone.xml nabor pravil / java / codesize.xml rulesets / java / comments.xml nabor pravil / java / coupling.xml nabor pravil / java / design.xml nabor pravil / java / empty.xml nabor pravil / java / finalizers.xml nabor pravil / java / imports.xml rulesets / java / j2ee.xml rulesets / java / javabeans.xml nabor pravil / java / junit.xml rulesets / java / logging -jakarta-commons.xml nabor pravil / java / logging-java.xml nabor pravil / java / migrating.xml rulesets / java / migrating_to_13.xml rulesets / java / migrating_to_14.xml rulesets / java / migrating_to_15.xml nabor pravil / java / naming.xml /java/optimizations.xml nabor pravil / java / strictexception.xml nabor pravil / java / strings.xml rulesets / java / sunsecure.xml nabor pravil / java / typeresolution.xml nabor pravil / java / unnecessary.xml rulesets / java / unusedcode.xml org. codehaus.mojo findbugs-maven-plugin 3.0.0
Opomba: Ti vtičniki so bili navedeni kot primeri. Kliknite vtičnike, da odkrijete celoten seznam razpoložljivih vtičnikov.
Kako ustvariti poročila v Maven
Preden ustvarite mesto projekta, je pomembno, da za vsak nov vtičnik zaženete testne enote in integracije . Lahko na primer uporabitemvn preverite spletno mestoukaz za ustvarjanje mesta projekta, ki bo že vključeval rezultate enote in integracijske teste .
Kako si lahko ogledate poročila v aplikaciji Maven
Kliknite na Moj projekt > Dokumentacija projekta > Poročila o projektu, da si ogledate poročila:
Vir XRef
To poročilo vam omogoča, da si ogledate izvorno kodo projekta:
Testni vir Xref
To poročilo vam bo omogočilo, da si ogledate navzkrižno referenčno različico izvorne kode preskusnega projekta.Dokumenti Java
To poročilo bo vsebovalo dokumentacijo API-ja JavaDoc :
Preizkusite dokumente Java
To poročilo bo vsebovalo dokumentacijo API-ja Test JavaDoc .Poročilo o zanesljivosti
To poročilo bo vsebovalo rezultate testiranja enot :
Varno poročilo
To poročilo bo vsebovalo rezultate testiranja integracije .Checkstyle
To poročilo bo prikazalo vse kršitve standardnih pravil skladnje v Javi:
Pravila za sporočila o napakah lahko urejate s konfiguracijo preverjevalnika po meri.
CPD
To poročilo bo poudarilo dvojne bloke kode v projektu:
Uredite
vrednostparameter za določitev najmanjše dolžine kode.
PMD
To poročilo bo poudarilo konstrukcijo slabe kode (ki je v nasprotju s trenutnim pravilnikom PMD ), kar lahko povzroči napake:
Uredite
parameter za spremembo privzetega PMD Ruleset.FindBugs
Maven bo ustvaril poročilo izvorne kode s knjižnico FindBugs. V obsežnem poročilu so navedene možne napake v vaši kodi: