Vinzenz Mai: Struktir Javascript-Referenz

Beitrag lesen

Hallo Kai,

Momentan beginnt jemand, die Javascript-Objektreferenz mehr oder weniger 1:1 ins Wiki zu übertragen.

vom Grundsatz her ist es erfreulich, dass sich was tut. Das sollte man nicht verhindern und auch nicht ausbremsen.

Da ich gerade diesen Bereich eigentlich immer schon (in mehreren Beziehungen) sehr suboptimal aufgeteilt und beschrieben fand,

Ich stimme Dir zu.

Ansonsten würde es bedeuten, daß alle Arbeit, die jetzt gemacht wird, unter Umständen doppelt gemacht oder komplett umgebaut werden muß.

Es gibt Schlimmeres. Ganz bestimmt wird es nicht die einzige derartige Baustelle sein. Hier sehe ich jedoch den Vorteil des Wikis: Es passiert etwas und man kann es sehen. Man kann es verbessern. Schön, dann machen wir's, wenn es nötig ist.

wenn einheitlich für jede Methode die Parameterübergabe und Rückgabe und für Eigenschaften der Rückgabe-Typ

nach einem Schema ähnlich dem, wie es z.B. auf php.net (Beispiel) verwendet wird (vielleicht etwas gestraffter, die einzelnen  Parameter nur kurz anreißen um einen schnellen Überblick zu haben und im folgenden text genauer beschreiben), aufgebaut würde.

das halte ich für eine gute Idee.

Also:
Syntaxübersicht
Liste der Parameter mit Beschreibung
Beschreibung eventueller Rückgabewerte
Hinweise & text & beispiel(e)

Ein entsprechendes Template dazu?

Solange keines da ist, wie wäre es mit der Methode, einfach mit gutem Beispiel und vorhandenen Möglichkeiten vorangehen?

Was soll mit Methoden/Eigenschaften geschehen, die deprecated sind? Weiterhin unter dem entsprechenden Objekt aufzählen (und z.B. mit entsprechender Hintergrundfarbe hinterlegen oder lieber einen eigenen Bereich "veraltete methoden/Eigenschaften"

was sich bewähren wird. Lassen wir uns überraschen.

Freundliche Grüße

Vinzenz