Seite 1 von 1

Sollte man lokal definierte Prozeduren...

Verfasst: 16. Nov 2007 08:18
von marek
...auch mit Vertrag etc. kommentieren?
Das dumme ist ja, dass sie Teile der Hauptprozedur sind, also keine selbstständigen Funktionen sind....

Verfasst: 16. Nov 2007 20:57
von ChRiZz88
Meiner Meinung nach enthält der Vertrag nur konsumierende und ausgebene Funktionen und Parameter und zwar im höchsten define. Sogesehen brauch man das nicht, wenns allerdings nich allzu offensichtlich ist, solltest du vll trotzdem einen kleinen Kommentar schreiben, was dein local macht.

Verfasst: 16. Nov 2007 21:20
von marek
...läuft

Verfasst: 17. Nov 2007 15:20
von misch0ng
Unser Übungs-Tutor meinte, man braucht für local definierte Prozeduren definitiv keinen Vertrag etc.

Verfasst: 18. Nov 2007 16:47
von giftnudel
Was? Das stimmt nicht. Ich würde immer einen verlangen! Zumal weil man da irgendwann den Überblick verliert, wenn man keinen hat. Vertrag und Purpose sollten immer da sein (ausser die Funktion ist so ein Luschi-Teil).

Verfasst: 19. Nov 2007 08:01
von Georg
lokal definierte Prozeduren brauchen meiner Meinung nach keinen Vertrag, schliesslich werden sie ja nur an dieser Stelle verwendet.
Man sollte aber immer bedenken, dass man selbst in einem Monat oder zwei vllt mal wieder wissen möchte wie man diese Prozedur verwendet, und da spart man sich ne menge Zeit, wenn schon dransteht, was man wo reinstecken muss und was man als Ergebnis erwarten kann/muss.
Seid egoistisch! kommentiert aus!

Verfasst: 19. Nov 2007 10:47
von Ulrich
Hallo,
bei lokalen Prozduren ist nicht explitzit ein Vertrag gefordert, allerdings ist ein Vertrag und kurzer Zweck eine gute Möglichkeit den Code von (komplexeren) lokalen Funktionen zu annotieren.
Ferner ist es meistens sinnvoll, diese Kommentierung der Übersichtlichkeit halber am Rand zu erstellen, und nicht in extra eingeschobenen Zeilen.

Generell gilt, das der Code für die Tutoren gut verständlich sein soll, einerseits duch Kommentare, andereseits aber auch z.B. durch sinnvoll gewählte Parameternamen.

Viele Grüsse

Ulrich Steinhoff