JSDoc Tags gleich? widersprüchlich?

[Der Martin]

Moin,

Das ist ja auch nicht das, was ich vermisse bzw. fordere. Der wichtigste Teil der Dokumentaion ist für mich, wie ich schon sagte, das Zusammenspiel vieler Funktionen, Objekte oder Methoden. Und das ist mit einer Beschreibung der Schnittstellen eben nicht getan, die ist nur ein kleiner Teil davon.

Du meinst also eine allgemeine Dokumentation abseits vom Code, sowas was in Dokumenten wie readme.txt zu stehen kommt?

ja, zum Beispiel.

Aber selbst dann willst du sicher nicht, dass die Schnittstellen nicht im Code dokumentiert sind. Also, ich verstehe immer noch nicht, was an *Doc als Teil der Dokumentation nicht sinnvoll sein soll.

Als Teil sehr wohl, das ist okay. Hab ich ja selbst mehrfach betont. Mir sind aber schon öfters Softwarepakete in die Hände gefallen, wo eine derartige, automatisch erstellte Dokomentation alles war. Ist ja auch verführerisch, dieses beruhigende Gefühl, man hätte schon was getan.
Damit allein fängt man aber als Nutzer nicht viel an. Das ist so, als solle man ein tolles Essen zaubern, denkt sich etwas aus, schreibt die Einkaufsliste dazu und meint dann, man sei fertig.

So long,
 Martin