Name

Homepage

Lizenz

Untersuchte Version

Letzter Untersuchungszeitpunkt

Kurzbeschreibung

Fazit

Einsatzgebiete

Einsatzumgebungen

Installation

Help -> Install new Software

Dokumentation

Wartung der Projektseite

Nutzergruppen und Support

Intuitive Nutzbarkeit

Einführendes Beispiel

public class CodeProAnalytix_simpleExample{
	
	public static void main(String[] args) {
	}
	
}

/**
 * Eine einfache Klasse zum Testen der Wirkungsweise des Audit-Tools von Google CodePro Analytix 
 *
 * @author		Adrian Gehrke
 * @version		0.1
 */
public class CodeProAnalytix_simpleExample{
	
	/**
	 * Die main-Methode
	 *
	 * @param args	Kommandozeilenparameter
	 */
	public static void main(String[] args) {
	}
	
	/**
	 * Die toString-Methode
	 *
	 * @return	gibt "CodeProAnalytix_simpleExample" zurück
	 */
	public String toString(){
		return "CodeProAnalytix_simpleExample";
	}
	
}

Detaillierte Beschreibung

1. Dynamic Auditing
   Es gibt die Möglichkeit, die Analyse des Codes dynamisch durchführen zu lassen. Dies hat den Vorteil, dass die Analyse automatisch beim Klick auf Speichern ausgeführt wird. Um "Dynamic Auditing" einzustellen, muss im Audit-Menü (in Eclipse: "CodePro" -> "Preferences" -> "Audit") der Reiter "Dynamic Auditing" und dort das Häkchen bei "Dynamically audit code" gesetzt werden. Unter "Use the audit rule set:" sollte für dieses Beispiel dann wieder "Effective Java" ausgewählt werden.
2. Export Violations
   Um die Analyseergebnisse ansprechend zu exportieren, muss lediglich im Kontextmenü des Audit-Windows (Rechtsklick ins Audit-Window) unter "Export Violations" die jeweilige Dateiendung ausgewählt werden. Danach wird die Datei am angegebenen Speicherort gespeichert. Die HTML-Ausgabe sieht (für unser einfaches Beispiel) in etwa so aus:
   
3. E-mail Report
   Sind richtige SMTP-Einstellungen (in Eclipse: "CodePro" -> "Preferences" -> "CodePro" -> "Mail") getroffen, besteht die Möglichkeit, Analyseergebnisse direkt per Mail zu versenden.
4. E-mail Report
   Sind richtige SMTP-Einstellungen (in Eclipse: "CodePro" -> "Preferences" -> "CodePro" -> "Mail") getroffen, besteht die Möglichkeit, Analyseergebnisse direkt per Mail zu versenden.
5. Rules / Rule Sets
   Ob (und welche) Warnung bei der Analyse angezeigt werden, geben die "Rules" an. Diese Regeln können unter "CodePro" -> "Preferences" -> "Audit" -> "Rules" angeschaut werden. Die "Rule Sets" (z.B. "Effective Java") fassen verschiedene Rules zusammen. Die meisten voreingestellten Rule Sets sind "locked", das bedeutet, dass sie nicht verändert werden können. Deshalb bietet es sich an, im "Rule Set"-Reiter ein eigenes Rule Set zu erstellen und seinen Anforderungen anzupassen.
6. Autofix
   Das Code Analysis Tool bietet die hilfreiche Funktion, Fehler automatisch zu fixen. Der "Autofix" kann für die jeweilige Regel beim Reiter "Autofix" ein- bzw. ausgestellt werden.

public class codeProAnalytix_detailedExample_withErrors_andLongTitle{
	
	String s1 = new String("a");
	int CONSTANT = new Integer(4);
	static final int constant_1 = 5;
	
	public static void main(String[] args) {
		codeProAnalytix_detailedExample_withErrors_andLongTitle t1 = new codeProAnalytix_detailedExample_withErrors_andLongTitle();
		t1.toManyParameters(1,2,3,4,5,6);
	}
	
	public codeProAnalytix_detailedExample_withErrors_andLongTitle(){
		System.out.println(s1);
		returnsNull();
		
		overload(3);
		overload(3.3);
		
		emptyCatch();
	}
	
	private int[] returnsNull(){ return null; }
	
	private void overload(int a){ return; }
	private void overload(double a){ return; }
		
	@Override protected void finalize() throws Throwable 
	{ 
	  try { 
	  } 
	  finally { 
	    super.finalize(); 
	  } 
	}
	
	private int toManyParameters(int a, int b, int c, int d, int e, int f){
		return a+b+c+d+e+f;
	}
	
	private void emptyCatch(){
		try{}
		catch(Exception e){}
	}
	
}

/**
 * verbesserte Fehler:
 * Klassenname muss großgeschrieben werden 
 * Klassenname darf nicht zu lang sein
 * Klassenname muss JavaDoc-Kommentar besitzen
 * Klasse muss toString()-Methode besitzen
 * 
 * @author		Adrian Gehrke
 * @version		0.1
 */
public class CodeProAnalytix_woErrors{
	
	/**
	 * alle Membervariablen müssen JavaDoc-Kommentar besitzen
	 * Strings sollten nicht per "new String()" erzeugt werden
	 */
	String s1 = "a";
	
	/**
	 * Falls Integer mit "new Integer()" erstellt sollte die Variable als Konstante definiert werden
	 */
	static final int CONSTANT = new Integer(4);
	
	/**
	 * Konstantennamen dürfen nicht mit einer Zahl enden
	 */
	static final int CONSTANT_ONE = 5;
	
	/**
	 * Die main-Methode
	 *
	 * @param args	Kommandozeilenparameter
	 */
	public static void main(String[] args) {
		CodeProAnalytix_woErrors t1 = new CodeProAnalytix_woErrors();
		t1.toManyParameters(1,2,3,4,5);
	}
	
	/**
	 * Konstruktor
	 */
	public CodeProAnalytix_woErrors(){
		System.out.println(s1);
		returnsNull();
		
		overload(3);
		overload_two(3.3);
		
		emptyCatch();
	}
	

	/**
	 * eine Methode sollte nicht "null" zurückgeben
	 *
	 * @return	gibt jetzt ein Array zurück
	 */
	private int[] returnsNull(){ 
		int returnArr[] = new int[5];
		return returnArr; 
	}
	
	/**
	 * erste Methode mit dem Namen "overload"
	 *
	 * @param	a	Integer-Variable
	 */
	private void overload(int a){ return; }
	
	/**
	 * Methoden, die überladen werden (gleicher Methodenname, gleiche Parameteranzahl) sollten vermieden werden
	 *
	 * @param	a	Integer-Variable
	 */
	private void overload_two(double a){ return; }
		
	// finalize sollte nicht verwendet werden
	/*
	@Override protected void finalize() throws Throwable 
	{ 
	  try { 
	  } 
	  finally { 
	    super.finalize(); 
	  } 
	}
	*/
	
	/**
	 * Methoden sollten maximal 5 Parameter haben
	 *
	 * @param	a	Integer-Variable
	 * @param	b	Integer-Variable
	 * @param	c	Integer-Variable
	 * @param	d	Integer-Variable
	 * @param	e	Integer-Variable
	 *  
	 * @return gibt Summe der Parameter zurück
	 */
	private int toManyParameters(int a, int b, int c, int d, int e){
		return a+b+c+d+e;
	}
	
	/**
	 * Catch-Blöcke sollten nicht leer sein
	 */
	private void emptyCatch(){
		try{}
		catch(Exception e){}
	}
	
	/**
	 * Die toString-Methode
	 *
	 * @return	gibt "CodeProAnalytix_simpleExample" zurück
	 */
	public String toString(){
		return "CodeProAnalytix_simpleExample";
	}
	
}