Parametererklärungen für die SF Doku

[swiss]

Wer muss denn da was nachvollziehen? Ich weiss schon was du meinst aber manchmal braucht es mehr Zeit einen Kommentar zu schreiben, als z.B. einen kleinen Fehler zu beheben.

[greentux]

Was dem Entwickler die fehlende Doku ist dem Editor das fehlende Changelog

[makki]

War Doku nicht die Sache für die Mädchen, die den Source nicht lesen wollen
Nee, im Ernst, ich denke die CV ist besser als 90% was da sonst so am Markt rumfleucht, was ich kenne..
Aber daran, verständliche Doku, mangelte es noch

Daher nochmal die Frage: gibt es nicht irgendein nettes System a la doxygen o.ä. das man dafür verwenden könnte, um inline zu dokumentieren? (hier wäre aber eher Erfahrung damit gefragt, weniger es zu ergooglen..)
Im finalen kann man das ja rausmachen (jsmin&Co) damit der wesentliche Vorteil: schlank - bleibt.

Makki

[greentux]

Ja, was soll ich sagen. Wir dokumentieren damit in der Firma jeglichen Code. Es ist eine recht schnelle Einarbeitung nötig, aber dann sind die Vorteile sichtbar.
Festgehalten werden dort primär Funktionsbeschreibungen, Parameter, security impacts etc. Die Userdoku entsteht dann weiterhin extern. Als Input ist der Doxygen Inhalt aber durchaus nützlich.

[Chris M.]

Wer muss denn da was nachvollziehen?

Ich
Ich bekomme die Info, dass es ein Seiten-Update gab per Mail. Und je nach Text in der Mail überlege ich mir das Ergebnis anzusehen oder auf später zu verschieben...

Ich weiss schon was du meinst aber manchmal braucht es mehr Zeit einen Kommentar zu schreiben, als z.B. einen kleinen Fehler zu beheben.

Ja, das ist mir klar. Bei Trivialitäten muss der Kommentar auch nicht lange sein, ein "Typo" bei korrigierter Rechtschreibung ist z.B. absolut ausreichend.

Was dem Entwickler die fehlende Doku ist dem Editor das fehlende Changelog

Ne, dass kann ich nicht stehen lassen. Ein Entwickler ist auch angehalten die Änderungen beim Hochladen in's SVN mit einem sinnvollen Kommentar zu versehen.

Der Unterschied ist der, dass ein Entwickler das so lange ignoriert, biss er mal suchen muss, ab welcher Version sich ein Bug eingeschlichen hat und sich dann fürchterlich ärgert in dem Saustall nicht schnell zu finden, was er sucht. Ab dann geht's meistens wie von selbst. Code kommentieren ist ähnlich...

Daher nochmal die Frage: gibt es nicht irgendein nettes System a la doxygen o.ä. das man dafür verwenden könnte, um inline zu dokumentieren? (hier wäre aber eher Erfahrung damit gefragt, weniger es zu ergooglen..)

Ergoogelt habe ich mir (aber inzwischen wieder vergessen...) dass es wohl eine relative Standard-Möglichkeit gibt. Und was noch viel wichtiger ist, dadurch lassen sich die Ein- und Ausgänge der Funktionen so beschreiben, dass man auch ein JS-Minify für die großen Jungs drüber laufen lassen kann, da es plötzlich versteht was es macht und so viel aggressiver loslegen kann.

Reale Erfahrung wäre da schön...

[makki]

@Chris: 100% Ack! So ein bisschen changelog ist schon ne feine Sache, ebenso wie Sachen ggfs. häppchenweise in abgeschlossenen Blöcken zu commiten.
Hab mir das sogar für Sachen angewöhnt (oder besser gesagt: bei "grossen" Projekten abgeguckt), die ich im wesentlichen zwar eh ganz alleine Pflege aber damit behält man erstens selbst den Überblick und zweitens besteht später wenigstens die Chance für andere

Makki

[swiss]

Ich bekomme die Info, dass es ein Seiten-Update gab per Mail. Und je nach Text in der Mail überlege ich mir das Ergebnis anzusehen oder auf später zu verschieben...

Boa. Das ist ja wie bei BigBrother

Ja, das ist mir klar. Bei Trivialitäten muss der Kommentar auch nicht lange sein, ein "Typo" bei korrigierter Rechtschreibung ist z.B. absolut ausreichend.

Ok ich versuche das mal einzuhalten

[swiss]

Noch eine Frage zu image und video...

Wo liegt hier der Unterschied? Es machen doch beide Widget's genau das gleiche oder sehe ich das falsch? Wäre dann nicht eines von beiden überflüssig?

[Chris M.]

Ist HTML5

Image ist ein klassisches Bild, dem man eine Rate mitgeben kann in der es neu geladen werden soll.

Video ist ein HTML5 <video> Tag.

Das ist drinnen, weil ich kann. Und angeblich die Zukunft ist.
Ob und wann es Web-Cams gibt, die besser per Video-Tag eingebunden werden, kann ich nicht beurteilen. Mit Web-Cams habe ich mich noch nicht beschäftigt.

[swiss]

Ok. Das kann man dem Benutzer auch so "verkaufen" Das macht die Arbeit noch leichter -> Copy&Paste Die Parameter sind ja 100% identisch.

[swiss]

Ich würde gerne eine einheitliche Navigation in der untersten Zeile der Handbuchseiten einführen. Damit das aber im Bezug auf die Widget's auch einen Sinn ergibt, werde ich erstmal mit der zentralen Übersichtsseite für die Widget's beginnen.

Leider fällt mir da momentan gerade kein sinnvoller Name dazu ein Wie würdet ich die Seite nennen?

[Chris M.]

Widget Übersicht (Deutsch)?

Kannst ja auch (zusätzlich) eine eigene Kategorie (z.B. CometVisu/Widget) dafür erstellen.

[swiss]

Manchmal denke ich einfach zu kompliziert

Das mit der Kategorie werde ich zusätzlich noch machen. Ich setze mich nach Möglichkeit morgen mal an die "Widget Übersicht".

[swiss]

So die Widgetübersicht ist online. Wir sind also bei ca. 75%

Danach heist es nur noch


Habt ihr noch weitere Anregungen und Wünsche?

[Chris M.]

Sehr gut!

Ich hätte jedoch die Seiten SourceForge.net: CometVisu/Den eingebauten Editor benutzen - Open Automation und SourceForge.net: CometVisu/Widget Übersicht (Deutsch) - Open Automation zu einer verheiratet.

Was schätzt Du, wie lange brauchst Du noch, bis Du "Release Fertig" bist?
Ich müsste nämlich noch die Demo-Config aufhübschen (weiß immernoch nicht wie...) und ein 0.6.0-RC3 releasen und dann ein paar Tage für finale Tests warten...