Zum Inhalt

Dokumentationswerkzeuge

Zur Erstellung von Dokumentationen habe ich bisher verschiedenste Ansätze verfolgt.

  • Doxygen Kommentare
  • Word
  • LaTex
  • markdown
  • mkdocs material

Von all diesen Ansätzen ist für mich mkdocs material die beste Variante. Dies liegt daran, dass es simple aufzusetzen ist und die Dokumentation von Klassen und ähnlichen Strukturen in getrennte Dateien erfolgen kann. Durch diese Aufteilung wird es erleichtert die Dokumentation von wiederverwendeten Code zu übernehmen und Änderungen einzutragen.