Wie sollte ein guter Prozedurkopf aussehen.

Aya · Verfasst: Mi 02.07.03 14:48

Hi,

also.. erstmal: Nein ich kann dir im moment nicht sagen was das Programm macht, weil:

Ich an der Arbeit bin und mein Chef das nich gern sehen würde *g*

Aber ok.. heute abend schau ich's mir mal an, allerdings sage ich gleich das es schwer wird. Denn wenn man einen Code bekommt den man verbessern soll, oder woraus man was lernen soll, weiß man was dieser macht und brauch sich nur darum kümmern WIE er es macht.
Und da besteht ein ziemlich großer unterschied.

Aber mal schaun, heute abend wenn ich daheim bin (Fahre btw heute abend wieder heim nach Kassel), schau ich's mir mal an

Au'revoir,
Aya~

_________________
Aya
I aim for my endless dreams and I know they will come true!

Tino · Beiträge: 9839 Erhaltene Danke: 45 Windows 8.1 Delphi XE4

mimi hat folgendes geschrieben:

deshalb sollte man den qullcode auch mit kometraen fühlen da man sonst sich nach 10 jahren nicht mehr im qullcode zurecht findet

Wenn du 10 Jahre lang den Sourcecode nicht angefasst hast kannst du ihn dann so wie so wegschmeisen und neu programmieren.

Gruß
Tino

Aya · Verfasst: Mi 02.07.03 14:57

huhu nochmal,

hab eben dochmal kurz drübergeguckt... auf den allerersten blick würde ich sagen das ding startet eine EXE (welche wohl in der RES Datei ist) in einem eigenen Process... aber kann auch total daneben liegen

Au'revoir,
Aya~

_________________
Aya
I aim for my endless dreams and I know they will come true!

Ehemaliges Mitglied Erhaltene Danke: 1

Hm, Nico war doch gar nicht online. :roll:

Popov · Verfasst: Mi 02.07.03 15:07

Eigentlich war die Frage hier wie ein Kommentarkopf einer Prozedur aussehen soll. Irgendiwie wurde das hier zu der Frage ob Kommentare den Quellcode unübersichtlich machen.

Naja, irgendwie kann ich das nachvollziehen. Jede zweite Zeile ein Kommentar, daß macht den Code schwerer lesbar. Nicht wegen der Kommentare, sondern weil die Kommentare die schnelle Lesbarkeit ein wenig behindern. Allerdings sah ich mal vor ca. zwei Jahre zufällig ein Code und da hat mir die Art der Kommentierung sehr gefallen. Seite dem mache ich es (fast) immer so.

Zuerst mal die normale Art der Kommentierung:

markieren

Delphi-Quelltext

1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:

  try
    // Handle des Gerätekontexts für den Desktop holen
    Can.Handle := GetWindowDC(GetDesktopWindow);
    //Bitmap an die Größe des Bildschirms anpassen
    Bmp.Width  := Screen.Width;
    Bmp.Height := Screen.Height;
    // Koordinaten des Desktops holen
    Rec := Rect(0, 0, Screen.Width, Screen.Height);
    //Desktopbereich in die Bitmap kopieren
    Bmp.Canvas.CopyRect(Rec, Can, Rec);
    ...

Hier die die ich benutze. Es ist nur eine Kleinigkeit, aber plötzlich stört der Kommentar bei dem Lesen nicht. Der Kommentar ist einfach um vier bis sechs Zeichen eingerückt.

markieren

Delphi-Quelltext

1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:

  try
        {Handle des Gerätekontexts für den Desktop holen}
    Can.Handle := GetWindowDC(GetDesktopWindow);
        {Bitmap an die Größe des Bildschirms anpassen}
    Bmp.Width  := Screen.Width;
    Bmp.Height := Screen.Height;
        {Koordinaten des Desktops holen}
    Rec := Rect(0, 0, Screen.Width, Screen.Height);
        {Desktopbereich in die Bitmap kopieren}
    Bmp.Canvas.CopyRect(Rec, Can, Rec);
    ...

Ich finde, daß es so besser lesbar ist. Wenn man will, dann ignorieren die Augen die Kommentare.

Das war jetzt so ein kleiner Hinweis nebenbei.

_________________
Popov

Aya · Verfasst: Mi 02.07.03 15:11

Luckie hat folgendes geschrieben:

Hm, Nico war doch gar nicht online. :roll:

Heißt das, dass ich richtig gelegen habe?

_________________
Aya
I aim for my endless dreams and I know they will come true!

Popov · Verfasst: Mi 02.07.03 15:17

Tino hat folgendes geschrieben:

Wenn du 10 Jahre lang den Sourcecode nicht angefasst hast kannst du ihn dann so wie so wegschmeisen und neu programmieren.

Nicht unbedingt. Vor einigen Jahren war ich bei einer Weiterbildung mit einem Programmierer, der diese plötzlich abgebrochen hat, weil er ein super Angebot bekommen hat. Bei der Jahr 2000 Umstellung mußten plötzlich etliche Programme umgestellt werden. Und etlich davon waren in Cobold. Die Programme waren inzwischen so alt, daß es kaum noch Leute gab die diese Sprache noch programmierten.

Wie man sieht, wird nach 10 Jahren nicht automatisch alles neu programmiert. Es laufen Programme die noch älter sind.

_________________
Popov

Popov · Verfasst: Mi 02.07.03 15:23

Aya hat folgendes geschrieben:

... auf den allerersten blick würde ich sagen das ding startet eine EXE (welche wohl in der RES Datei ist) in einem eigenen Process...

und

Luckie hat folgendes geschrieben:

...

markieren

Delphi-Quelltext

1:
2:
3:

...
LoadResource(0, FindResource(0, 'Image', 'EXE'))); 
...

...

Nanana, wir werden da doch nicht pfuschen und aus einer Zeile den Sinn erraten

_________________
Popov

Aya · Verfasst: Mi 02.07.03 15:28

Öhm.... ich hab mir schon den kompletten Code angeschaut.
das mit dem LoadResource war das was mich am meisten verwirrt hat, da ich absolut keinen sinn daran sehe wieso das ding "Image" heißt..

_________________
Aya
I aim for my endless dreams and I know they will come true!

hansa · Beiträge: 3079 Erhaltene Danke: 9

@Aya: soll das eventuell ein Rätsel werden?

_________________
Gruß
Hansa

Aya · Verfasst: Mi 02.07.03 17:53

hansa hat folgendes geschrieben:

@Aya: soll das eventuell ein Rätsel werden?

mh? Nein, wieso??

_________________
Aya
I aim for my endless dreams and I know they will come true!

Ehemaliges Mitglied Erhaltene Danke: 1

Ja, er extrahier aus der Resosurce eine Exe und führt sie aus, ohne sie auf die Festplatte zu schreiben.

Und Image hießt auf deutsch Abbild. Wenn du eine Anwendung startetst wird ein Abbild von der Exe in den Speicher geladen und dann spricht man von einem Image.

Aya · Verfasst: Mi 02.07.03 20:17

*grinst fröhlich*
Aber ok, dann lasst uns nun mal wieder zum Thema zurückkommen, welche Proceduren Header ihr verwendet

Au'revoir,
Aya~

_________________
Aya
I aim for my endless dreams and I know they will come true!

mimi · Beiträge: 3458 Ubuntu, Win XP Lazarus

jetzt sieht man ganz gut, das kommetrae ganz nützlich sein könnten:)
aber solche rate spiele könnten wir eingetnlich öffter machen oder ?

_________________
MFG
Michael Springwald, "kann kein englisch...."

Aya · Verfasst: Mi 02.07.03 21:33

mimi hat folgendes geschrieben:

jetzt sieht man ganz gut, das kommetrae ganz nützlich sein könnten:)
aber solche rate spiele könnten wir eingetnlich öffter machen oder ?

Und ich sage es gern nochmal.. ich hab da nich wild drauf losgeraten! Ich bin den Code zeile für zeile durchgegangen, hab in der OH nachgeguckt was TProcessInformation (welches z.B. in der Hilfe nur im WinSDK unter PROCESS_INFORMATION zu finden ist) ist etc und hab mir dann meinen Teil dazu gedacht was das ding macht.

Da is nix dran rumgeraten oder sonstwas (oder hast du erraten was die Procedure macht, nur weil da in ner Resource ne EXE drin is?! bzw da nichmal sicher stand das es ne EXE is, sondern nur das die Resource so heißt. Image hätte genausogut nen Bild in dem abschnitt EXE sein können, nur hätte dann der kram NtHeadern etc nichmehr logisch zusammengepasst).

Au'revoir,
Aya~

PS: Und ich bleibe dabei, das ich überladene ProcedurenKommentare sinnlos finde... zummindest für mich

_________________
Aya
I aim for my endless dreams and I know they will come true!

mimi · Beiträge: 3458 Ubuntu, Win XP Lazarus

Zitat:

PS: Und ich bleibe dabei, das ich überladene ProcedurenKommentare sinnlos finde... zummindest für mich

aber mit kometraen ist es einfacher zu lesen, und man muss nicht immer in der oh nachschaeun was jetzt der und der befehl macht:)

_________________
MFG
Michael Springwald, "kann kein englisch...."

Aya · Verfasst: Mi 02.07.03 22:11

mimi hat folgendes geschrieben:

Zitat:

PS: Und ich bleibe dabei, das ich überladene ProcedurenKommentare sinnlos finde... zummindest für mich

aber mit kometraen ist es einfacher zu lesen, und man muss nicht immer in der oh nachschaeun was jetzt der und der befehl macht:)

Wenn man ihn nicht kennt, und den Code für etwas eigenes verwenden will, oder z.B. einen Fehler finden soll, muß (!!) man das immer tun.. (Ich meine jetzt in der OH nachschauen was der Befehl macht)

_________________
Aya
I aim for my endless dreams and I know they will come true!

Popov · Verfasst: Mi 02.07.03 23:04

Das ganze geht irgendwie in die falsche Richtung. Das sollte jetzt kein Übereden-Thread für Kommentare werden. Wer Kommentare nicht will, der soll es sein lassen. Spätestens, wenn man bei einem alten Programm, an dem man lange Zeit gearbeitet, nach einem Jahr nicht mehr durchblickt, spätestens dann usw.

Ansonsten sehe ich bis jetzt, daß bis auf Luckie und mich (hin und wieder) kaum einer Kommentarköpfe benutzt. Also, ich hab mit mehr gerechnet. Gibt es hier keine Berufsprogrammierer? Da kann mir keine erzählen, daß man sich in einer Firma Kommentarköpfe sparrt. Aber wenn's so ist.

Ich wollte eigentlich nur paar professionelle Köpfe sehen, da ich mir meinen selbst entwickelt habe und immer wieder erweitern muß. Ich such mal im Internet.

_________________
Popov

Aya · Verfasst: Mi 02.07.03 23:12

Popov hat folgendes geschrieben:

Gibt es hier keine Berufsprogrammierer? Da kann mir keine erzählen, daß man sich in einer Firma Kommentarköpfe sparrt. Aber wenn's so ist.

Doch doch, ich programmiere Beruflich

Aber wie schon gesagt, ich benutze auch hier kaum Kommentare (bzw halt nur da wo es wirklich sinnvoll ist).
Und obwohl mein Chef selber Informatik Studiert hat, aber keinen einzigen Delphi/C++ oder sonstwas befehl kann (er kann nur die Theorie), hat er keine großen probleme meine SourceCodes zu verstehen (OHNE Kommentare). Und wenn er es kann, kann es ein anderer Programmierer mit sicherheit

Au'revoir,
Aya~

PS: Aber ok, ich bin hier nu ma still.. hab meine Meinung ja gesagt und will net zuviel in's OffTopic.

_________________
Aya
I aim for my endless dreams and I know they will come true!

tommie-lie · Beiträge: 4373 Ubuntu 7.10 "Gutsy Gibbon"

Auch wenn ich nicht beruflich programmiere (wie sollte ich auch? *lol*):
Ich benutze auch Kommentare für meine Prozeduren. Bis vor kurzem hat sich das Design von Projekt zu Projekt verändert, jetzt wird er automatisch mit GExperts eingefügt und sieht so aus:

markieren

Delphi-Quelltext

1:
2:
3:
4:
5:

{-----------------------------------------------------------------------------}
{ Date:      2003-06-20
{ Procedure: IsInString
{ Purpose:   Checks whether a substring is conatined in a string
{-----------------------------------------------------------------------------}

Ist eine Prozedur wirklich von jemand anderem als mir, wird das dazunotiert, ansonsten steht mein Copyright im Unitheader, und dann ist davon auszugehen das der Inhalt auch von mir ist.

_________________
Your computer is designed to become slower and more unreliable over time, so you have to upgrade. But if you'd like some false hope, I can tell you how to defragment your disk. - Dilbert

	Mitgliederliste
	Gruppen
	Das Team
	Richtlinien
	Synonyme