För några år sedan utvecklade jag ett program som kontrollerar om Java-källkod följer några uppställda kodningsstandardregler. Nu är programmet, som heter CodeCompanion, lite gammalt och jag underhåller det inte längre, men jag tänkte att det kanske kan vara till nytta åt någon, så jag gör det tillgängligt för nedladdning här.
Det finns tre olika installationsvarianter att välja mellan. Alla tre kräver att det finns en Java VM installerad.
-
cc12win.exe (1,6 MB) med installationsprogram för Windows.
-
cc12jav.jar (1,6 MB) med installationsprogram som körbar Jar-fil.
-
cc12man.zip (0,26 MB) utan installationsprogram. Packa up zip-filen och starta med java -jar codecompanion.jar.
CodeCompanion kontrollerar att källkoden uppfyller 37 kodningsstandardregler, som till exempel namnkonventioner. Om det är någon av reglerna som man inte gillar så går det att stänga av den. Den största begränsningen med programmet är att det inte finns något stöd för Java 1.5. Om man kontrollerar källkod som innehåller några av nyheterna i Java 1.5 så kommer CodeCompanion rapportera att det finns kompileringsfel i koden.
Skärmbilder
CodeCompanion har både ett grafiskt gränssnitt och ett kommandoradsbaserat. Det här är programmets huvudfönster. I det visas andra fönster, som till exempel projektfönster.
När CodeCompanion har kontrollerat ett antal källkodsfiler visas resultatet i ett rapportfönster. Alla felmeddelanden är sorterade efter feltyp.
Man kan titta på varje undersökt källkodsfil och få felen markerade. Om man för muspekaren över markeringen visas en förklaring.
CodeCompanion innehåller 37 regler som är valda för att ge högkvalitativ källkod. Det går att välja vilka av reglerna som ska användas. Reglerna som gäller namnkonventioner kan anpassas för att passa olika namngivningskonventioner.
Det finns ett inbyggt hjälpsystem som beskriver varje regel i detalj, med exempel och motivering till varför regeln finns.
