Softwareentwicklung mit Delphi

Softwareentwicklung mit Delphi

Posts 1-3 of 3
  • User photo
    Thomas Scheel
    The company name is only visible to registered members.
    Delpi 2006: Dokumentation generieren
    Leider ist dieses Feature nur spärlich dokumentiert.
    Interessant wäre aber, ob man auch eigene Beschreibungen bzw. überhaupt Beschreibungen zu Methoden und Feldern hinzufügen kann, da es sich ja ansonsten wieder mehr oder minder um eine Krücke handelt.
    Falls jemand dazu schonmal etwas gelesen hat wäre ich dankbar für jeden Hinweis.

    MfG

    Thomas
    • 27 Jan 2006, 10:28 am
  • Michael Schindler
    Michael Schindler    Premium Member   Group moderator
    The company name is only visible to registered members.
    Re: Delpi 2006: Dokumentation generieren
    Hallo,

    ich habe die Erstellung der Dokumentation auch als erstes getestet!

    Folgendes konnte ich herausfinden:

    Die Erstellung der Dokumentation bezieht sich auf die Modellierung.
    D.h. wenn man die Together Unterstützung für sein Projekt aktiviert
    (Menü Project -> Togehter Support) wird in der Model View ein Gerüst
    der vorhanden Applikation erstellt.

    In den Klassendiagrammen (über Project Manager erreichbar) kann man auf
    die Methoden und Felder klicken und bekommt dann im Object Inspector
    die Eigenschaften dazu.

    Wenn man mit der rechten Maustaste z.B. auf eine Methode klickt gibt es
    den Menüpunkt "User properties".
    In der darauf folgenden Makse kann man sich eine Eigenschaft "Beschreibung" erstellen
    und bei "Value" den Text dazu eingeben.

    Diese Eigenschaft wird von nun an im Object Inspector in der Modellansicht je Methode/Feld angezeigt.
    Auch die erstellte Dokumentation (Model View -> Project -> rechte Maus -> Generate Documentation)
    enthält dieses Property und wird mit angezeigt.

    Im Quelltext werden diese User Properties vor der jeweilligen Methode/Feld angezeigt:

    ///<Beschreibung>Diese Methode stellt den Konstruktor bla bla
    ///bla bla
    ///</Beschreibung>

    Ich habe im Quelltext einfach mal die gleiche Syntax per Hand für andere Methoden und Felder
    verwendet und auch da wurden in der Dokumentation die Texte angezeigt.

    Es macht Sinn die Funktion zu verwenden wenn man die Modell Ansichten verwendet. Die daraus
    erzeugten Dokumentationen bringen vor allem für andere Programmierer die sich einarbeiten
    müssen viel.

    Für "nur" Quelltext dokumentieren reicht diese Funktion aus meiner Sicht nicht. Vor allem gibt
    es ja bereits Freeware Tools mit deren Hilfe sich JavaDoc ähnliche Dokus erstellen lassen die auch
    im Quelltext über Kommentare gesteuert werden.

    Gruß,
    M.Schindler
    • 27 Jan 2006, 2:18 pm
  • User photo
    Thomas Scheel
    The company name is only visible to registered members.
    Re^2: Delpi 2006: Dokumentation generieren
    Danke für deine ausführliche Antwort.

    Cih war davon ausgegangen, dass eine JavaDoc-ähnliche Funktion jetzt bereits integriert ist, was ja auch die Form der Ausgabe vermuten lässt.
    Dein Tip mit den benutzerdefinierten Feldern ist gut, soweit hatte ich mit dieses Feature noch nicht herumgespielt, dass mir aufgefallen ist, dass sich diese Elemente auch in der Dokumentation wiederfinden.
    Komfortabel lässt sich damit jedoch nicht arbeiten. Vielleicht stellt sich ja noch heraus, dass die Funktion integriert aber schlecht dokumentiert ist.

    Gruß

    Thomas
    • 27 Jan 2006, 3:14 pm