Kommentieren des Programms?

Hallo
Endlosschleifenbastler
Endlosschleifenbastler
Beiträge: 162
Registriert: 22. Apr 2015 19:03

Kommentieren des Programms?

Beitrag von Hallo »

Hallo,
Darf den Programm kommentieren um uns so eine 'Hilfestellung' beim Praxistestat schafft?

VG,
Hallo. :)

Fatih
Erstie
Erstie
Beiträge: 13
Registriert: 25. Mai 2014 18:03

Re: Kommentieren des Programms?

Beitrag von Fatih »

Ja, ist sogar empfohlen, soweit ich weiß

infermaticker
Erstie
Erstie
Beiträge: 21
Registriert: 25. Apr 2015 00:21

Re: Kommentieren des Programms?

Beitrag von infermaticker »

Es wurde doch mal gesagt, dass die Kommentare evtl. automatisiert entfernt werden. Was stimmt denn nun?

Hallo
Endlosschleifenbastler
Endlosschleifenbastler
Beiträge: 162
Registriert: 22. Apr 2015 19:03

Re: Kommentieren des Programms?

Beitrag von Hallo »

Würde ich jetzt auch gerne wissen.. :roll:

hololol2
Endlosschleifenbastler
Endlosschleifenbastler
Beiträge: 154
Registriert: 27. Apr 2015 14:13

Re: Kommentieren des Programms?

Beitrag von hololol2 »

Kommentare können entfernt werden.
Prinzipiell sind zu genaue Kommentare nicht sinnvoll, da diese wohl entfernt werden.
Eine grundsätzlich Kommentierung ist aber auf jeden Fall sinnvoll und wenn diese nicht zu detailliert ist, bleibt sie vielleicht sogar im Testat erhalten

GS-812
Windoof-User
Windoof-User
Beiträge: 30
Registriert: 25. Apr 2015 12:47

Re: Kommentieren des Programms?

Beitrag von GS-812 »

Hallo Zusammen,

ich habe meinen Code gut kommentiert, um es dem Tutor leichter zu machen.

Ich hoffe darauf, dass nur die Komentare bezüglich des gelöschten Teils entfernt werden,
der Rest aber hoffentlich vorhanden bleibt.

Somit wüsste man nicht genau, was man ergänzen muss (falls es aus den Komentaren ersichtlich wäre),
man könnte aber zumindest den Rest relativ leicht überfliegen.


Hier nur ein kurzes Beispiel:
Hier weiß man noch, dass "instanceof" und "size" schon geprüft sind, also nicht ergänzt werden müssen.
(Ja, dafür braucht man im Beispiel eigentlich keine Kommentare :lol: )

public boolean equals(Object obj)
{
// Check if object is MathList
if (!(obj instanceof MathList))
return false;

// Compare sizes
if (this.size() != list.size())
return false;

while (pivot != null)
{
// Compare data
if (!pivot.data().equals(pivot2.data()))
return false;

pivot = pivot.next();
pivot2 = pivot2.next();
}

return true;
}


wird zu

public boolean equals(Object obj)
{
// Check if object is MathList
if (!(obj instanceof MathList))
return false;

// Compare sizes
if (this.size() != list.size())
return false;

// TODO: Here we removed something

return true;
}


Da ich kein Tutor bin, habe ich keine Ahnung, ob Löschungen in diese Richtung gehen ;-)

Vielleicht könnte ein Tutor etwas dazu schreiben, diese erhalten vermutlich Anweisung, wie mit Kommentaren umzugehen ist.

hololol2
Endlosschleifenbastler
Endlosschleifenbastler
Beiträge: 154
Registriert: 27. Apr 2015 14:13

Re: Kommentieren des Programms?

Beitrag von hololol2 »

Ich war schon bei einem "TestTestat" dabei. Wenn ich es richtig in Erinnerung habe, werden Kommentare die nicht zum gelöschten Teil gehören stehen gelassen. Auch Kommentare die allgemein sind bleiben eventuell stehen.
Allerdings waren da die "Richtlinien" zum Löschen noch nicht endgültig und wurden noch erarbeitet. Folglich kann sich das auch ändern.
Letzendlich wird es wohl auch kleine Unterschiede je nach Tutor geben.

Felix Sternkopf
Mausschubser
Mausschubser
Beiträge: 77
Registriert: 21. Apr 2015 23:09

Re: Kommentieren des Programms?

Beitrag von Felix Sternkopf »

Kommentare in der zu löschenden Funktion werden gelöscht, desweiteren wird der Code nach weiteren zu hilfreichen Kommentaren durchsucht (auskommentierte Codefragmente, eindeutige Hinweise auf Lösungen) werden gelöscht, auch die JavaDocs werden durchsucht.

Antworten

Zurück zu „Archiv“