wiki:csharpDoku
Last modified 3 years ago Last modified on 2015-01-20 07:17:02

Dokumentaation tekeminen Doxygenilla

Doxygen on ilmainen automaattinen dokumentaation generointijärjestelmä, joka tukee useita ohjelmointikieliä (mm. C, C++, C#, Java, Python, PHP,...). Doxygenillä voi luoda dokumentit niin nettikäyttöön HTML-muodossa, kuin myös tulostusta varten esimerkiksi Latex-, PDF- tai Word-muodossa.

Alla olevat ohjeet ovat Windowsille.

1. Ohjelman lataaminen ja asentaminen

2. HTML-dokumentin luominen

  • Käynnistä Doxygenin graafinen käyttöliittymä (Doxywizard)
  • Muokkaa Doxygenin asetuksia seuraavasti
    • Wizard/Project
      1. Anna projektin nimi (project name) ja versio (version). Näitä tietoja käytetään etusivun tietoina.
      2. Valitse lähdekoodin juurihakemisto (Source code directory), eli kansio, jossa kooditiedostot sijaitsevat.
      3. Valitse Scan recursively, jolloin Doxygen ottaa dokumentaation mukaan myös alihakemistot ja mahdolliset nimiavaruudet.
      4. Anna kohdekansio, johon dokumentaatiotiedostot tuotetaan.
    • Wizard/Mode
      1. Valitse All entities, jolloin myös nimiavaruudet listataan dokumentaatiossa.
      2. Valitse kieli, jolle dokumentit optimoidaan - meidän tapauksessamme C#.
    • Wizard/Output
      1. Varmista että HTML on valittuna ja valitse kehys/puu-malli HTML-sivun layoutiksi (frame/tree).
      2. Latex, Man, RTF ja XML-dokumentteja emme tämän kurssin tarpeisiin näitä emme tarvi.
    • Wizard/Diagrams: Valitse sisäänrakennettu luokkakaaviogeneraattori (Built-in class diagram generator).
    • Expert/Project: Ota ruksi pois kohdasta FULL_PATH_NAMES.
    • Expert/Build: Laita ruksi kohtaan EXTRACT_STATI
    • Run Paina "Run doxygen" ja kun ajo on tehty klikkaa "Show HTML output"
  • Tarkista, että tuotettu HTML-sivu on kunnossa, eli kaikki haluamasi luokat ja metodit löytyvät dokumentaatiosta.

3. Tehtyjen asetusten tallentaminen ja lataaminen Doxywizardissa

  • Paina File -> Save as ja osoita asetustiedostolle sopiva paikka. Nimeksi voit antaa vaikka Doxyfile tai jonkun muun, vaikka doxyasetukset.txt. Tärkeintä on että muistat tiedoston nimen myöhemmin.
  • Ladataksesi aiemmin tallentamasi asetustiedosto klikkaa File -> Open ja etsi tekemäsi tiedosto.

4. Tehtyjen asetusten käyttäminen komentoriviltä

  • Siirry komentoriville
  • Kirjoita kokeeksi doxygen. Jos ohjelmaa ei löydy hakupolusta, niin lisää ensin hakemisto C:\Program Files\doxygen\bin sinne. (Mitä tarkoittaa hakupolkuun lisääminen?)
    • Jos käytät 64-bittistä Windowsia niin hakupolkuun lisättävä hakemisto on C:\Program Files (x86)\doxygen\bin.
  • Siirry kansioon, jossa 3. vaiheessa tekemäsi asetustiedosto sijaitsee.
  • Kirjoita doxygen asetustiedosto (sijoita "asetustiedoston" kohdalle oikea tiedoston nimi.

(Ohjeiden lähde: http://danielsaidi.wordpress.com)