Erstellung Dokumentation

[barnti]

Hallo,

ich dokumentiere zur Zeit mein Projekt. Ich benutze DelphiCodeToDoc

http://dephicodetodoc.sourceforge.net/

Was meint ihr?

Was benutzt ihr?

[Luckie]

Hm, so was habe ich schon lange gesucht. Macht einen ganz brauchbaren Eindruck.

PS.: Könntest du mir mal eben sagen wie ich das mit den Kommentaren hinbekomme? Ich habe da immer

Zitat:

Description
#No TAG found in source code#

Stehen. Wie müssen die Kommentare aussehen, damit er sie erkennt?

[Muetze1]

Moin!

Steht doch auf der Page:

Formating with inline TAGs

oder

nach dem JavaDoc Stil

MfG
Muetze1

[Luckie]

Ja. Schön. Und warum klappt das beimir nicht, wenn ich das so schreibe:

Delphi-Quellcode:

/// Klasse für die Kontakte  
type
  TContactClass = class(TObject)
  private
    FClassVersion: String;

Ichhabe es auch schon nur mit zwei "/" probiert, ging auch nicht.

Edit: Habe es gefunden. Der Kommentar muss nach type stehen.

[barnti]

Hallo Luckie,

ich war auch lange auf der Suche nach so einem tool. Da ich weiß, dass dies auch von anderen begehrt
ist, habe ich dies mal gepostet.

Ich habe auch noch nicht alles so hinbekommen! Aber Deine Lösung mit den Inline-Kommentaren ist schon eine feine Sache.

Vielleicht kann man hier weiterhin zu diesem Thema seine Ideen austauschen...

[barnti]

Hallo,

vielleicht kann mir jemand erzählen wie ich die Inline-Tags richtig setze!?

Delphi-Quellcode:

interface


uses
  Windows, Menus, ImgList, Controls, StdCtrls, CheckLst, DBCtrls, Grids,
...

type
  TForm_Main = class(TForm)
    // Hauptmenü der Anwendung
    MainMenu: TMainMenu;
    Menue_Datei: TMenuItem;
    Menue_Beenden: TMenuItem;
    Menue_Drucken: TMenuItem;
    Menue_Speichern: TMenuItem;

Ich habe mal so versucht die Felder zu kommentieren. Leider steht bei mir immer *No Tag found*

Weiß jemand Rat? Die mitgelieferte Beschreibung hilft mir leider nicht weiter...

[Muetze1]

Moin!

Ich benutze zwar Doc-O-Matic und der würde den oben genannten Stil so akzeptieren wie gewünscht, aber trotzdem würde ich sowas vermuten als Lösung:

Delphi-Quellcode:

interface


uses
  Windows, Menus, ImgList, Controls, StdCtrls, CheckLst, DBCtrls, Grids,
...

type
    // Mainform der Anwendung
  TForm_Main = class(TForm)
    MainMenu: TMainMenu;        // Hauptmenü der Mainform
    Menue_Datei: TMenuItem;     // "Datei" - Menu im Hauptmenu
    Menue_Beenden: TMenuItem;   // "Datei->Beenden" - Menupunkt
    Menue_Drucken: TMenuItem;
    Menue_Speichern: TMenuItem;

MfG
Muetze1

[MisterNiceGuy]

Hallolo, ich kapier hier grad ganix! Kann mir mal jemand erklären worum es hier geht und was es mit diesen Tags auf sich hat? Danke schön!! :mrgreen:

[barnti]

Hallo,

das mit den Tags für die Fields funktioniert:

Delphi-Quellcode:

...
type
/// Hauptformular für die Userinteraktion
  TForm_Main = class(TForm)
/// Hauptmenü der Anwendung
    MainMenu: TMainMenu;
/// Button 'Datei' des Hauptmenüs
    Menue_Datei: TMenuItem;
/// Button 'Beenden' des Hauptmenüs
    Menue_Beenden: TMenuItem;
...

Das mit den Variablen funktioniert leider noch nicht: *No Tag Found* :(

@MisterNiceGuy: Einfach mal in das tool schauen. Damit kann man sein Projekt dokumentieren.

[sakura]

Zitat:

Zitat von barnti

Was benutzt ihr?

:mrgreen: Wieder meine Standard-Antwort. Ich benutze auch dazu ModelMaker. Da habe ich alles in einem: Code-Editor, UML, Diagramme, Quelltext-Doku, Anwender-Doku, ...

...:cat:...