Fortran: Anhang D: Natural Docs

Aus Wikibooks
Zur Navigation springen Zur Suche springen
<<< zur Fortran-Startseite
<< Anhang D: Quellcodedokumentation Weblinks >>
< ROBODoc Doxygen >


Auch der Dokumentationsgenerator Natural Docs unterstützt bereits Fortran ab dem Standard 90/95 (free source form) in einer Basisvariante. Natural Docs ist in der Programmiersprache Perl verfasst. Als Softwarelizenz wurde die General Public License gewählt. Zum Zeitpunkt der Kapitelerstellung war die Version 1.35 aktuell.

Ein einfaches Beispiel[Bearbeiten]

Fortran 90/95-Code (free source form)
! Section: Beispielprogramm
!   Autor: Intruder, Datum: 04.08.2007


! Group: circle
!   Modul fuer Kreisfunktionen
module circle
  implicit none


  ! Constant: pi
  !   pi = 3.14
  real, parameter :: pi = 3.14


  contains
    ! Function: area
    !   Berechnet Kreisflaeche
    !
    ! Parameters:
    !   r ... Radius (real)
    !
    ! Returns:
    !    Kreisflaeche (real)
    real function area( r )
      implicit none 

      real, intent( in ) :: r
    
      area = r ** 2 * pi
    end function area
end module circle


! Group: main
!   Hauptprogramm
program main
  use circle
  implicit none
  
  real            :: r, a
  
  read( *, * ) r
  a = area( r )
  write( *, * ) "Flaeche = ", a
end program main

Erstellung der HTML-Dokumentation:

NaturalDocs -i . -o HTML bsp -p .

Screenshot:

Naturaldocs.png

Kurze Erläuterung[Bearbeiten]

Natural Docs filtert die benötigten Informationen mit Hilfe von Schlüsselwörtern aus den Kommentarbereichen der Fortrandateien. Die im Beispielprogramm verwendeten Schlüsselwörter sind:

  • Section
  • Group
  • Constant
  • Function
  • Parameters
  • Returns

Groß- Kleinschreibung spielt bei diesen Schlüsselwörtern kein Rolle. Abgeschlossen wird ein Schlüsselwort mit einem Doppelpunkt.

Beim Ausgabeschalter (-o) muss neben einem Ausgabeverzeichnis auch noch ein Ausgabeformat angegeben werden. Möglich sind

  • HTML
  • FramedHTML

Beim Schalter -p ist ein (Projekt)Verzeichnis anzugeben, wo Natural Docs einige benötigte Dateien ablegen kann, die nicht direkt zur erstellten Dokumentation gehören.

Für weitergehende Infos zu Natural Docs wird auf die unten angegebene Webpräsenz zu dieser Software verwiesen.

Weblinks[Bearbeiten]



<<< zur Fortran-Startseite
<< Anhang D: Quellcodedokumentation Weblinks >>
< ROBODoc Doxygen >