Hinweis bei Aufruf einer Funktion

[Ghostwalker]

@Bernhard

Sinn und Zweck der Meldung sind 2 Dinge. Zum einen einfach als Info, das sich der Anwenderprogrammierer nicht wundert, wenn "Äpfel + Birnen" tatsächlich funktioniert. Zum anderen aber auch als Hinweis, das man hier, je nach Anwendung, ggf. Optimierungspotenzial hat.

Im konkreten Fall gehts um Operatoren mehrer Typen, die untereinander via Basistyp verknüpft sind.

Beispiel:

Delphi-Quellcode:

Type
  Seconds = Record
  private
    fvalue : int64;
  public
    Class Operator Add(const left:Seconds;const right:int64):Seconds
  end;

  Minutes = Record
  private
   fvalue : int64;
  public
  Class Operator Add(const Left:Seconds;right:Minutes):Seconds //<-- hier würde beim Aufruf ein Hinweis kommen
end;

Beim Aufruf von Minutes.Add würd ich gern einen Hinweis ausgeben, das die Minuten quasi umgerechnet werden, um die Operation durch zu führen.

So wie es aussieht ist deprecaded wohl die einzige Alternative, da man hier einen eigenen Text angeben kann (library usw. erlauben das nicht).

Im prinzip bräuchte ich was wie:

{$MESSAGE HINT CALL 'Mein Hinweis'} oder

function Blubb:boolean;CMESSAGE HINT CALL 'Mein Hinweis'; Der 1.Parameter gibt an, um was es sich handelt (HINT|WARNING|ERROR). Der zweite gibt an, wann das ganze
ausgegeben werden soll (CALL = Aufruf der Funktion/Prozedur/Operator oder COMPILE beim compilieren der Funktion. Schließlich die Nachricht, die ausgegeben werden soll.

[himitsu]

Help-Insight / Documentaion-Insight

Delphi-Quellcode:

    ///   <summary>
    ///     bla bla bla
    ///   </summary>
    Class Operator Add(const left:Seconds;const right:int64):Seconds

Da man Klassenoperatoren aber nicht direkt aufruft (der Methodenname steht nicht im aufrufenden Quelltext),
würde dieser Hilfetext wohl nirgendwo zu sehen sein. (hier also nur zur Dokumentaion beim Ansehen des Quellcodes)

[Der schöne Günther]

Hätte ich auch gesagt. API-Dokumentation und/oder ein Wiki. Wer die Anleitung nicht liest, Quelltext in den Editor wirft und dann sagt "Hurra, er kompiliert. Wir liefern aus" ist selber schuld

[Sherlock]

Zitat von Der schöne Günther:

Hätte ich auch gesagt. API-Dokumentation und/oder ein Wiki. Wer die Anleitung nicht liest, Quelltext in den Editor wirft und dann sagt "Hurra, er kompiliert. Wir liefern aus" ist selber schuld

Das kann ich so nicht akzeptieren. Mann muss ja schon Delphi Korrektur lesen, außerdem 3rd Party Komponenten, den eigenen Code und jetzt noch das Framework von Kollegen? Kann man dafür nicht irgendwen rausdeuten, so wie im Freeware-Bereich Horden von Menschen nur darauf warten den Linux Kernel zu reviewen und zu debuggen?




Sherlock

[Bernhard Geyer]

Zitat von himitsu:

Help-Insight / Documentaion-Insight

Delphi-Quellcode:

    ///   <summary>
    ///     bla bla bla
    ///   </summary>
    Class Operator Add(const left:Seconds;const right:int64):Seconds

Hätte ich jetzt auch vorgeschlagen.

Gut Dokumentieren das der Nutzer gleich sieht was er nutzt.
Evtl. den Methodennamen passend wählen das man sowas schon aus dem Namen ableiten könnte.

[Ghostwalker]

Help-Insight/Doku-Insight ist eine schöne Sache, an und für sich. Aber wie Himitsu schon ausführte, wird sie kaum gelesen.

Da Delphi selbst auch solche Hinweise/Warnungen ausgiebt (grob im Sinn ist mir das bei der Erweiterung von Parametern bei übergabe an eine Funktion), dacht ich mir, das es da wohl sowas geben könnte.

[himitsu]

Zitat von Ghostwalker:

Aber wie Himitsu schon ausführte, wird sie kaum gelesen.

Was hier aber vor allem an den Operatoren liegt und weil Delphi dort diese Hilfe nicht anbietet.

Ansonsten nutze ich das auch ausgiebig als InCode-Dokumentation und spare mir oft eine zusätzlich externe Doku.
"Ordentliche" Bezeichner, eine übersichtliche Klassenstruktur und kurze Erklärung direkt vor Ort reicht ja meistens.



Depecated und {$MESSAGE} nur dort, wo IMMER jedesmal etwas extrem Wichtiges angezeigt werden muß.

[Der schöne Günther]

Kann mir jemand ein praktisches Beispiel für eine "Nachricht" im Quellcode nennen die man hinterlassen muss dass sie auch wirklich jeder, ob er will oder nicht, jedes mal um die Ohren gehauen bekommt?

[himitsu]

experimental oder deprecated ala "das Ding ist scheiße/steinzeituralt. Nicht mehr / noch nicht verwenden!!!" ist das Einzige, was mir einfällt.