Fortran: Anhang D: ROBODoc

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

ROBODoc ist freie Software unter der GNU General Public License. Dieses Tool verwendet die normalen Kommentarzeichen der jeweiligen Programmiersprache und nutzt für die Dokumentationsgenerierung eigene Auszeichnungstags innerhalb dieser Kommentare.

Ein einfaches Beispiel[Bearbeiten]

Beispielcode[Bearbeiten]

Fortran 90/95-Code (free source form)
!****h* Beispielprogramm/circle
! NAME
!   circle
!
! DESCRIPTION
!   Modul fuer Kreisfunktionen
!
! AUTHOR
!   Intruder
!
! CREATION DATE
!   04.08.2007
!******
module circle
  implicit none


  !****d* circle/pi
  ! NAME
  !  pi
  !
  ! DESCRIPTION
  !  pi = 3.14
  !******
  real, parameter :: pi = 3.14


  contains
    !****f* circle/area
    ! NAME
    !   area
    !
    ! DESCRIPTION
    !   Berechnet Kreisflaeche
    !
    ! INPUTS
    !   r ... Radius (real)
    !
    ! RESULT
    !    Kreisflaeche (real)
    !******
    real function area( r )
      implicit none 

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


Fortran 90/95-Code (free source form)
!****h* Beispielprogramm/main
! NAME
!   main
!
! DESCRIPTION
!   Hauptprogramm
!
! AUTHOR
!   Intruder
!
! CREATION DATE
!   04.08.2007
!******
program main
  use circle
  implicit none
  
  real            :: r, a
  
  read( *, * ) r
  a = area( r )
  write( *, * ) "Flaeche = ", a
end program main

Erstellen der Dokumentation[Bearbeiten]

Erstellen der Dokumentation im HTML-Format als Multidokument mit Index:

robodoc --src . --doc doc --multidoc --html --index

Screenshot[Bearbeiten]

Robodoc.png

Kurze Erläuterung[Bearbeiten]

ROBODoc filtert die erforderlichen Angaben für die Dokumentation aus den Fortran-Kommentaren heraus. Zu diesem Zweck sind in den Kommentaren Header einzubauen. Diese Header bestehen aus

  • begin marker
  • items
  • end marker

Ein begin marker beginnt immer mit 4 Sternchen, dann kommt ein Buchstabe als Elementkennzeichner. Es folgt ein Stern und dann Angaben zur Stellung des Elementes in der Dokumentationshierarchie.

In diesem Beispiel wurden folgende Elementkennzeichner verwendet:

  • h ... Modul
  • f ... Funktion
  • d ... Konstante (Definition)

Der Hierarchiebaum wird durch die strikte Angabe von

übergeordnetes Element/aktuelles Element

erstellt.

Die verschiedenen Items sind dann unterhalb dieses begin markers durch Schlüsselworte gekennzeichnet:

  • NAME
  • DESCRIPTION
  • AUTHOR
  • etc.

Sie dienen zur konkreten Beschreibung des jeweiligen Elementes.

Abgeschlossen wir ein solcher Dokumentations-Header durch den end marker. Dieser wird durch mindestens drei Sternchen gebildet.


Zwecks Erstellung der Dokumentation sind viele Optionen verfügbar. Die unbedingt erforderlichen Angaben sind

  • --src mit Angabe der Quelldatei bzw. dem Verzeichnis, in dem die Quelldateien liegen
  • --doc mit einem Vornamen für die Dokumentationsdateien bzw. der Bezeichnung des gewünschten Dokumentationsverzeichnisses
  • eine Angabe zu der Dokumentationsform:
    • --multidoc ... Die Dokumentation wird in Form mehrerer Einzeldateien in des Dokumentationsverzeichnis geschrieben
    • --singledoc ... Der Dokumentationsinhalt wird in eine einzige Datei geschrieben
  • die Angabe des Dokumentationsformates:
    • --html ... HTML
    • --rtf ... RTF
    • --latex ... LaTeX
    • --dbxml ... XML DocBook

Für dieses Beispielprojekt wird auch noch ein Index erstellt (--index).

Detaillierte Informationen zu ROBODoc sind unter dem nachfolgend angeführten Weblink zur ROBODoc-Homepage abrufbar.

Weblinks[Bearbeiten]



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