Jan 25

Quellcode dokumentieren mit NaturalDocs

Programmierung Keine Kommentare »

Heute habe ich mich mal auf die Suche nach einem Software-Dokumentationswerkzeug gemacht, das aus Quellcodekommentaren automatisch eine Dokumentation erstellt. Da ich verschiedene Sprachen zum Entwickeln verwende (angefangen beim guten alten PHP bis hin zu den ersten Gehversuchen in C#) wäre ein Tool, das verschiedene Programmiersprachen unterstützt, sehr willkommen.

Gefunden habe ich zwei Kandidaten: Doxygen und Natural Docs. Hängen geblieben bin ich bei Natural Docs, das auf die sonst üblichen, von JavaDoc bekannten Dokumentationsdirektiven (@author etc) verzichtet und eher auf “natürliche” Sprache setzt:

  1. /*
  2.    Function: Multiply
  3.  
  4.    Multiplies two integers.
  5.  
  6.    Parameters:
  7.  
  8.       x - The first integer.
  9.       y - The second integer.
  10.  
  11.    Returns:
  12.  
  13.       The two integers multiplied together.
  14.  
  15.    See Also:
  16.  
  17.       <Divide>
  18. */
  19. int Multiply (int x, int y)
  20.    {  return x * y;  };

Mal schauen, wie es sich in der Praxis schlägt :)