Autor Beitrag
Bergmann89
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: So 27.09.09 13:46 
HI,

ich bastel grad an nem Programm, was mir die Kommentare aus dem Quelltext in ein ordenltiches HTML-Format bringt. Ich bin soweit damit fertig die Unit zu analysieren und wollte das Ergebnis mal zum Testen hier posten, um evlt. Bugs zu erkennen. Wäre net wenn ihr eure Units mal schnell damit checken könntet. Syntax der Kommentare sieht wie folgt aus:
ausblenden volle Höhe Delphi-Quelltext
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:
32:
unit Unit1;

{alles was über dem Interface steht wird als beschreibung für die Unit angesehen}

interface

uses
  Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
  Dialogs;

const
  TEST_CONST = 'test'//Kommentare für Konstanten stehen immer dahinter

var
  //Kommentar Test1
  //|    Kommentar Test2
  //|    |      Kommentar Test3
  Test1, Test2, Test3: Integer;  //(' ' und '|' werden automatisch entfent) dieser kommentar hat keine Bedeutung

type
  //Kommentar der Klasse
  TForm1 = class(TForm)
  private
    //Kommentar Test1
    //|    Kommentar Test2
    //|    |      Kommentar Test3
    Test1, Test2, Test3: Integer;
    property Test: Integer read Test1; //Kommentar der Eigenschaft
    procedure TEST; //Kommentar der Prozedure/Funktion
  end;

implementation


€: neue Version (6. Okt): Das Prog erstellt jetzt die HTML zu den Units. Das Layout ist, wie schon gesagt, an das von PasDoc angelehnt (bz. übernommen)...

Mfg & Thx Bergmann
Einloggen, um Attachments anzusehen!
_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^


Zuletzt bearbeitet von Bergmann89 am Di 06.10.09 13:58, insgesamt 1-mal bearbeitet
jaenicke
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 19314
Erhaltene Danke: 1747

W11 x64 (Chrome, Edge)
Delphi 11 Pro, Oxygene, C# (VS 2022), JS/HTML, Java (NB), PHP, Lazarus
BeitragVerfasst: So 27.09.09 14:44 
Ja, das sieht erst einmal ganz gut aus. Wirklich ausführlich konnte ich es was die Kommentare angeht nicht so testen, da ich die eher etwas anders setze. Aber die Codeanalyse sieht soweit gut aus und auch die Kommentare, die vorhanden waren, wurden richtig angezeigt. :zustimm:

Interessant wird dann wie die generierten Seiten dann aussehen, denn ich benutze im Moment die delphiinterne Dokufunktion. Das heißt, wenn du an der Stelle bessere Ergebnisse erzielst, insbesondere was die Klassendiagramme angeht, wäre das schon interessant.
dummzeuch
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 593
Erhaltene Danke: 5


Delphi 5 ent, Delphi 6 bis Delphi XE8 pro
BeitragVerfasst: So 27.09.09 15:30 
Hi,

user profile iconBergmann89 hat folgendes geschrieben Zum zitierten Posting springen:

ich bastel grad an nem Programm, was mir die Kommentare aus dem Quelltext in ein ordenltiches HTML-Format bringt.


Ohne Deinen Enthusiasmus bremsen zu wollen: Du weisst, dass es solche Programme schon gibt? Und dass einige davon Open Source sind, Du also dort einsteigen koenntest und damit nicht bein 0 anfangen muesstest?

Empfehlen koennte ich PasDoc, wobei ich da etwas voreingenommen bin, da ich das Projekt einige Monate stark beeinflusst habe.

twm
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: So 27.09.09 17:29 
Hey,

user profile iconjaenicke hat folgendes geschrieben Zum zitierten Posting springen:
Interessant wird dann wie die generierten Seiten dann aussehen, denn ich benutze im Moment die delphiinterne Dokufunktion. Das heißt, wenn du an der Stelle bessere Ergebnisse erzielst, insbesondere was die Klassendiagramme angeht, wäre das schon interessant.

Wie sieht die Delphi-Interne Dokufunktion aus? Un gibts die auch schon bei Delphi7? Wäre toll wenn du da ma n Bsp. mit hocjh laden könntest...



user profile icondummzeuch hat folgendes geschrieben Zum zitierten Posting springen:
Empfehlen koennte ich PasDoc, wobei ich da etwas voreingenommen bin, da ich das Projekt einige Monate stark beeinflusst habe.

Ja das hab ich auch daheim, aber da gefällt mir die Position der Kommentare nicht... Die HTML-Datei wollt ich dann auf der von PasDoc aufbauen. Is das OpenSource? Bzw. darf ich den Code davon benutzen?

MfG Bergmann.

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
dummzeuch
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 593
Erhaltene Danke: 5


Delphi 5 ent, Delphi 6 bis Delphi XE8 pro
BeitragVerfasst: So 27.09.09 18:24 
user profile iconBergmann89 hat folgendes geschrieben Zum zitierten Posting springen:

user profile icondummzeuch hat folgendes geschrieben Zum zitierten Posting springen:
Empfehlen koennte ich PasDoc, wobei ich da etwas voreingenommen bin, da ich das Projekt einige Monate stark beeinflusst habe.

Ja das hab ich auch daheim, aber da gefällt mir die Position der Kommentare nicht... Die HTML-Datei wollt ich dann auf der von PasDoc aufbauen. Is das OpenSource? Bzw. darf ich den Code davon benutzen?

PasDoc steht unter der GPL, d.h. Du kannst mit dem Code erstmal machen was Du willst. Wenn Du aber das Programm weitergeben willst, musst Du auch den Sourcecode weitergeben.

Evtl. koennte man den PasDoc Code auch auf der Parserseite modular gestalten, wie es ja schon auf der Doku-Generierungs-Seite ist, so dass Du statt alles neu zu schreiben, einfach das Parsing-Modul austauschen kannst. Dann waere die Erzeugung von HTML oder LaTeX quasi schon fertig.

Es gibt zu PasDoc eine Mailing-Liste (Siehe pasdoc.sipsolutions.net/ ), allerdings auf Englisch. Michalis Kamburelis, der derzeitige Projektleiter, liest dort mit und antwortet in der Regel schnell.

twm
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: So 27.09.09 18:28 
Hey,

ich wollte den Aufbau der HTML aber noch etwas umgesatlten und nur den grundlegenden Aufbau nutzen. Und den Code kann ja jeder einsehen, muss ja nur die HTML mit nem Editor öffnen. Also wäre das möglich, ohne nochma mit jmd darüber zu reden, oder?

MfG Bergmann

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
dummzeuch
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 593
Erhaltene Danke: 5


Delphi 5 ent, Delphi 6 bis Delphi XE8 pro
BeitragVerfasst: So 27.09.09 18:46 
user profile iconBergmann89 hat folgendes geschrieben Zum zitierten Posting springen:

ich wollte den Aufbau der HTML aber noch etwas umgesatlten und nur den grundlegenden Aufbau nutzen. Und den Code kann ja jeder einsehen, muss ja nur die HTML mit nem Editor öffnen. Also wäre das möglich, ohne nochma mit jmd darüber zu reden, oder?

Wie schon gesagt: GPL
Das gibt Dir alle Moeglichkeiten vorausgesetzt Du haeltst Dich an die Spielregeln.

twm
jaenicke
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 19314
Erhaltene Danke: 1747

W11 x64 (Chrome, Edge)
Delphi 11 Pro, Oxygene, C# (VS 2022), JS/HTML, Java (NB), PHP, Lazarus
BeitragVerfasst: So 27.09.09 20:23 
user profile iconBergmann89 hat folgendes geschrieben Zum zitierten Posting springen:
Wie sieht die Delphi-Interne Dokufunktion aus? Un gibts die auch schon bei Delphi7? Wäre toll wenn du da ma n Bsp. mit hocjh laden könntest...
Die Modellingunterstützung gibt es ab Delphi 2006, ist aber selbstverständlich auch in Turbo Delphi drin gewesen. Im Anhang ein kleines Beispiel, nicht besonders gut angepasst, einfach nur kurz hingeschnipselt. ;-)
Einloggen, um Attachments anzusehen!
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: So 27.09.09 21:15 
Hey,

sieht irgwendwie alles ziemlich unübersichtlich aus...da werd ich mich doch eher an dem HTML-Code von PasDoc orientieren...

MfG Bergmann.

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: Di 06.10.09 13:58 
Hey,

Neues Update im 1. Post:
Das Prog erstellt jetzt die HTML zu den Units. Das Layout ist, wie schon gesagt, an das von PasDoc angelehnt (bz. übernommen)...

MfG Bergmann.

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
JungerIslaender
ontopic starontopic starontopic starofftopic starofftopic starofftopic starofftopic starofftopic star
Beiträge: 427
Erhaltene Danke: 5

Win XP
Delphi 7; Delphi 2005
BeitragVerfasst: Di 06.10.09 14:25 
Ich weiß nicht ob dein Programm schon funktioniert, aber bei mir sind bis auf das fertige layout die html Seiten leer? Also egal mit welcher source ich die lade.

Desweiteren heißt der erstellte Ordner Unbekannt-Datein. Ich glaub das sollte auch nicht so sein.
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: Di 06.10.09 14:32 
Hey,

ich hät vlt noch was zu benutzung sagen sollen^^:
1.: Units hinzufügen
2.: Units laden
3.: ProjektName eingeben (sonst "Unbekannt")
4.: HTML erzeugen
dann sollte es funktionieren

MfG Bergmann

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
HelgeLange
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 735
Erhaltene Danke: 6

Windows 7
Delphi7 - Delphi XE
BeitragVerfasst: Di 06.10.09 16:35 
bei "Load units" krieg ich allerdings eine Schutzverletzung (nicht-initialisierter Pointer das ist)

_________________
"Ich bin bekannt für meine Ironie. Aber auf den Gedanken, im Hafen von New York eine Freiheitsstatue zu errichten, wäre selbst ich nicht gekommen." - George Bernhard Shaw
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: Di 06.10.09 18:48 
Hey,

user profile iconHelgeLange hat folgendes geschrieben Zum zitierten Posting springen:
bei "Load units" krieg ich allerdings eine Schutzverletzung (nicht-initialisierter Pointer das ist)

Kannst du mir die Unit mal schicken? da check ich das ma durch...

MfG Bergmann

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^
HelgeLange
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 735
Erhaltene Danke: 6

Windows 7
Delphi7 - Delphi XE
BeitragVerfasst: Di 06.10.09 19:34 
nicht wirklich, kommerzielles Paket :(

_________________
"Ich bin bekannt für meine Ironie. Aber auf den Gedanken, im Hafen von New York eine Freiheitsstatue zu errichten, wäre selbst ich nicht gekommen." - George Bernhard Shaw
Bergmann89 Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 1742
Erhaltene Danke: 72

Win7 x64, Ubuntu 11.10
Delphi 7 Personal, Lazarus/FPC 2.2.4, C, C++, C# (Visual Studio 2010), PHP, Java (Netbeans, Eclipse)
BeitragVerfasst: Di 06.10.09 22:00 
Hey,

ich hatte letztens auch ne Zugriffsverletzung, vlt hab ich die ja schon behoben.
Ich arbeite grad noch an paar verbesserungen danach gibts n update...

MfG Bergmann.

_________________
Ich weiß nicht viel, lern aber dafür umso schneller^^