Dokumentation von Quellcode in wiss. Arbeiten

[Olli]

Ich denke, daß dein Professor sicher nichts dagegen hat, wenn du eine doxygen-kompatible Syntax in deinem Projekt benutzt. Mithilfe von Doxygen kann man die Dokumentation als LaTeX oder HTML erzeugen ... es gibt auch andere Systeme.

Hier ein Beispiel was Doxygen für dich machen kann:
http://clam.iua.upf.edu/doc/CLAM-dev...s__Xerces.html

Hier ein Beispiel (geklaut von CommentMaker-Pro). Das Problem könnte sein, daß man einen Parser für Pascal-Code braucht.

Code:

///////////////////////////////////////////////////////////////////////////////
///  [public|private] [FunctionName]
///  <TODO: insert function description here>
///
///  @param $P_INOUT$ $P_NAME$ $P_TYPE$ $P_DEFAULT$   <TODO: insert parameter description here>
///
///  @return $R_TYPE$ <TODO: insert return value description here>
///
///  @remarks <TODO: insert remarks here>
///
///  @see <TODO: insert text here>
///
///  @author $AUTHOR$
///////////////////////////////////////////////////////////////////////////////

Die Konvention was du wie beschreibst, bleibt natürlich ganz dir überlassen. Bin allerdings nciht sicher, ob es eher eine praktische oder eher eine theoretische Frage war.