richtig kommentieren

julia123

Erfahrenes Mitglied
hi leute,

hab eine frage zum verstehen und kommentieren wie kann ich dieses stück quellcode kommentieren:

Code:
/**
	 * 
	 * @param f
	 * @throws IOException
	 */
	public static void setFile(File f)throws IOException{
		workFile = f;
		if(!f.canRead()) f.createNewFile();
		readCSV(workFile);
	}
 

sheel

I love Asm
Indem du bei AAA die methode beschreibst und bei BBB den Sinn des Parameters?

Java:
  /**
     * AAA
     * @param f BBB
     * @throws IOException
     */
    public static void setFile(File f)throws IOException{
        workFile = f;
        if(!f.canRead()) f.createNewFile();
        readCSV(workFile);
    }
 

julia123

Erfahrenes Mitglied
ich versteh die methode nicht :( .

AAA: Setzt den Arbeitsort(Verzeichnis) fest
BBB: f ist der Ordner

hab ich das so richtig gemacht?
 

sheel

I love Asm
Da ich nicht weiß, was workFile und readCSV genau machen
und was in dieer Klasse sonst noch relevant ist kann ich dir auch nicht 100%ig sagen,
was da passiert.

Auf jeden Fall gehts es nicht um irgendein Verzeichnis, nur um eine einzelne Datei.

Übrigens: Die Zeile mit dem if ist uU. problematisch.
Es kann auch eine existierende Datei geben, die man nicht lesen kann (darf)...