| 

.NET C# Java Javascript Exception

Antwort #A1791 zur Frage #F498: Getter/Setter dokumentieren?

Diese Antwort hat bisher 2 Versionen. Frage #F498: Getter/Setter dokumentieren? - Antwort #A1791


Version 2
20.03.2010 14:23:52
Dies ist die aktuelle Version
Wenn man mit CodeGenerierungsTools arbeitet, um vielleicht eine technische Doku zu erstellen, macht es schon Sinn so viel wie möglich zu kommentieren, insbesondere um einfach mehr Semantik an den Konsumenten beispielsweise einer Serviceschnittstelle oder an einem Entwickler der die Methode verwenden soll, zu bringen.

Ich sehe auch einen Mehrwert darin, wenn man etwas Beispielcode, wie man denn eine (komplexe) Methode / Operation verwenden kann, mit einbringt.

Hier geht es auch darum, das du deinen Code - eben auch ein paar Monate später - schnell wieder rein findest und dann auch sogleich verstehst, wenn mal eine Änderung oder Erweiterung ansteht.
Mario Priebe 5,7k 2 9
Version 1
20.03.2010 14:23:52
Wenn man mit CodeGenerierungsTools arbeitet, um vielleicht eine technische Doku zu erstellen, macht es schon Sinn so viel wie möglich zu kommentieren, insbesondere um einfach mehr Semantik an den Konsumenten beispielsweise einer Serviceschnittstelle oder an einem Entwickler der die Methode verwenden soll, zu bringen.

Ich sehe auch einen Mehrwert darin, wenn man etwas Beispielcode, wie man denn eine (komplexe) Methode / Operation verwenden kann, mit einbringt.

Hier geht es auch darum, das du deinen Code - eben auch ein paar Monate später - schnell wieder findest und dann auch sogleich verstehst, wenn mal eine Änderung oder Erweiterung ansteht.
Mario Priebe 5,7k 2 9