Dokumentation: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Jeremi (Diskussion | Beiträge) |
Jeremi (Diskussion | Beiträge) |
||
| Zeile 97: | Zeile 97: | ||
Klassen Methoden, Prozeduren, Funktionen, etc. sollten mit [[Dokumentation#XML_Kommentare|XML Kommentaren]] versehen werden. Diese werden verwendet um die automatisierte Dokumentation zu bauen. | Klassen Methoden, Prozeduren, Funktionen, etc. sollten mit [[Dokumentation#XML_Kommentare|XML Kommentaren]] versehen werden. Diese werden verwendet um die automatisierte Dokumentation zu bauen. | ||
Außerdem werden XML Kommentare dazu verwendet, bei der Codeeingabe Hinweise in einer Tooltip Box anzuzeigen, so dass das arbeiten mit dokumentierten Funktionen deutlich leichter fällt. [[Kategorie:Code-Beispiele]] | Außerdem werden XML Kommentare dazu verwendet, bei der Codeeingabe Hinweise in einer Tooltip Box anzuzeigen, so dass das arbeiten mit dokumentierten Funktionen deutlich leichter fällt. [[Kategorie:Code-Beispiele]] | ||
{{BA|Jeremi|Hier auf Parameter der XML Kommentare eingehen? So kommt sicher die Frage, ob nun ein Parameter, der in der summary beschrieben wurde jetzt auch nochmal einzeln beschrieben werden muss -> ja!}} | |||
== Wie man NICHT kommentieren sollte == | == Wie man NICHT kommentieren sollte == | ||
