f90doc

f90doc je alat za dokumentovanje za Fortran 90, lak za učenje, koji je napisao Erik Demaine. U osnovi, alat generiše dokumentaciju u obliku HTML strana, iz Fortran 90 izvornog koda. Dokumentacija se izvodi iz komentara koji počinju sa !! napisanih (po želji) u jednostavnom i intuitivnom dokumentacijskom jeziku koji je lako čitljiv i u samom izvornom kodu, a lepo se formatira u HTML-u. f90doc je sličan javadoc-u, ali ne zahteva da komentari budu napisani u HTML-u.

Prikaz

Lista glavnih karakteristika za najnoviju verziju:

• Koristan (a jednostavan) dokumentacijski jezik koji se lako čita pomoću tekst editora i može se konvertovati u HTML, i koji podržava liste, podebljani (bold), iskošeni (italic) i “doslovan” (verbatim) tekst.
• deklaracije module, subroutine, function, type, i interface, kao i deklaracije promenljivih, od kojih svaka ponaosob može biti komentarisana.
• Sadržaj za svaki top-level programski blok (modul, program, podprogram, ili funkcija), sa linkovima ka punom opisu svakog od delova koda.
• komande use u modulima, čime se generišu linkovi.
• komande call u programima, podprogramima, i funkcijama, čime se generišu liste, a mogu da se generišu i linkovi (opciono).
• komande module procedure u interfejsima, čime se generišu linkovi.
• Utvrđivanje javnosti/privatnosti objekata modula.

Nekoliko ograničenja: podržani su samo free-form ulazni fajlovi, i dokumentuju se samo objekti u modulima.

Srodni radovi

Postoje tri srodna projekta, za različite programske jezike:

• javadoc (za jezik Java), kojim je f90doc prvobitno inspirisan.
• DOC++ (za jezike C/C++ i Java).
• Perl-ov Plain Old Documentation (POD).

Dokumentacija

Za više detalja o alatu f90doc, uključujući i to kako da ga koristite, pogledajte stranicu sa njegovom dokumentacijom.

Za brzi početak, možete pogledati ovaj Fortran 90 kod i dobijenu HTML dokumentaciju, kao jednostavan primer.

Dostupnost

f90doc je besplatan, distribuira se u skladu sa MIT licencom (počev od verzije 0.4.0). Takođe, ukoliko napravite izmene u f90doc-u, za koje mislite da mogu biti korisne i ostatku sveta, cenio bih ako biste ih poslali meni na razmatranje.

• Preuzmite najnoviju verziju (0.4.0), objavljenu 4. januara, 2005. Biće vam potreban Perl 5.003 ili noviji.
• Pre nego prijavite problem, pogledajte stranicu prijavljeni problemi i rešenja (uključujući i to kako koristiti f90doc u Windows okruženju).
• Detalji o ovom i o prethodnim izdanjima (uključujući kopije svih starih verzija).

RPM pakete je pripremio Mark Ashdown.

Molim vas da pošaljete sve komentare, sugestije, kritike, ili (daleko bilo) izveštaje o greškama u programu (bagovima) na edemaine@mit.edu. Takođe, pošaljite mi e-mail ako želite da budete obavešteni o budućim izmenama i dopunama.