\begin{slide}{Code dokumentieren?}


warum?
\begin{itemize}\itemsep 0pt
\item nach innen (Implementierung)

  für Wartung, Weiterentwicklung
\item nach außen (Schnittstelle)

  soll ausreichen für Benutzung
\end{itemize}

wo?
\begin{itemize}\itemsep 0pt
\item intern (im Quelltext selbst)
\item extern (separates Dokument)
\end{itemize}

(Literatur: Steve McConnell, Code Complete 2)

\end{slide}

\begin{slide}{Abstand v. Dokumenation u. Code}

\dots je größer, desto gefährlicher!
(d. h. interne Dokumentation ist noch relativ sicher)

wenn möglich, externe Dokumente 
daraus durch Werkzeuge generieren.

warum nur unsicher: der Compiler kann zwar den Code
prüfen und ausführen, aber nicht die Kommentare.

Ideal: schreibe \emph{selbst-dokumentierenden} Code!

\end{slide}

