Hi!
Nein, es soll keine Hilfe für den Anwender sein, sondern eine Dokumentation für den Anwender - in dem Fall ist Anwender aber nicht gleichzusetzen mit Nutzer des Systems. Ich hole etwas weiter aus. Es handelt sich um ein System, das später einen Admin hat (der nicht ich bin), der einen groben technischen Überblick bekommen soll, um auch mal etwas anpassen zu können oder ähnliches (z.B. an einem Template-System, das ja nur aus
HTML besteht). Dafür sollen die einzelnen Sachen dokumentiert sein - das soll keine Bedienungshilfe für den Nutzer des Systems sein. Ich versuche es mal mit einem Beispiel (grad in Delphi).
Sei als Quelltext sowas gegeben (inkl. Kommentar für Programmierer etc)
Delphi-Quellcode:
procedure foo()
begin
showmessage("bar"); // zeigt bar an
end;
Und dazu würde ich dann gerne einen Kommentar verfassen wie
Zitat:
Mit dieser Methode kann man dies und das machen. Dabei ist zu beachten, dass sie nur in diesem oder jenem Kontext aufgerufen werden darf und dabei die und die Nebenwirkungen hat.
Wenn ich das in die Quellcode-Datei reinschreibe finde ich das für denjenigen, der mit PHP dann nicht viel am Hut hat, nicht so komfortabel.
Grüße, Frederic