Kann ich meinen funktionierenden Code begutachten lassen?

[Jackaroo]

Soeben habe ich mich hier im Forum frisch registrieren lassen. Bevor ich irgendwelchen Unmut auf mich ziehe, würde ich gerne eine Grundsatzfrage klären.

Ich habe erste Gehversuche in Python gemacht und stolpere so unkontrolliert vor mich hin. Alles, was ich machen wollte, hat auch irgendwann funktioniert. Bei der Lösungssuche helfen mir ein paar Bücher, die python.org-Seite und die unzähligen Foren, auf denen man beim Googeln landet. Also: ja, ich wusste mir bisher immer zu helfen. Aber: zwar funktioniert bisher alles, aber ist es auch "gut" programmiert. Wenn ich meine Progrämmle anschaue, dann bin ich noch nicht zufrieden. Unbehaglich fühle ich mich hinsichtlich der geschickten Anwendung von lokalen, globalen und Instanzvariablen, wann sollte man eine Klasse definieren, wann eine Funktion, ... .

Kann ich meine Progrämmle hier anschauen und kommentieren lassen? Wenn ja, wo und wie sollte ich das tun? Was muss ich beachten, damit keiner "den Aff'" bekommt?

Danke für Eure Einstiegshilfe!

[EyDu]

Hallo und willkommen im Forum!

Kurze Programme kannst du einfach mittels Code-Tags hier im Forum posten, wenn es etwas mehr ist, dann lagere es am besten in ein Pastebin aus (oben unter dem Logo ist eins verlinkt) und verweise darauf. Es werden sich sicherlich einige finden welche einen Blick auf den Code werfen und Hinweise geben, wenn es nicht zu viel Code ist.

Sebastian

[lunar]

Für diesen Zweck gibt es das Codesnippets-Forum. Dort kannst Du Deinen Quelltext zeigen und um Kommentare bitten. Es gibt dabei nichts besonderes zu beachten, doch um möglichst viel Kommentare zum Quelltext zu bekommen, ist es sinnvoll, sich möglichst an die folgenden Punkte zu halten:

Der Quelltext sollte dokumentiert und kommentiert sein, damit Deine Absicht und Dein Ziel auch dann klar ist, wenn der Quelltext nur schwer verständlich und somit nicht selbsterklärend ist. Auch sollte er nicht zu lang sein und eine gewisse logische Struktur haben, denn je länger und konfuser der Quelltext ist, desto weniger fühlen sich andere zum Begutachten dieses Quelltexts motiviert.

Am besten kopierst Du den Quelltext auch nicht einfach in Deinen Beitrag, sondern veröffentlichst ihn in einem Pastebin wie http://paste.pocoo.org (vergiss dabei nicht, die Syntaxhervorhebung zu aktivieren). Im Pastebin kann der Quelltext einfach direkt heruntergeladen werden, was Personen, die den Quelltext selbst probieren möchten, die Arbeit erleichtert. Zudem stören lange Quelltextstücke beim Lesen von Beiträgen.

[Jackaroo]

Vielen Dank erstmal für Eure Erläuterungen. Ich werde das mal so probieren.

Nur diese Frage noch dazu: Wann wäre ein Code-Beispiel zu lang? Mein aktuellstes ist zwischen 100 und 200 Zeilen.

[lunar]

@Jackaroo: Es tut mir leid, Dir so eine armselige Antwort zu geben, doch das ist hauptsächlich Gefühlssache. Jedes Mitglied dieses Forums hat andere „Toleranzgrenzen“, zumal auch andere Faktoren eine Rolle spielen. 500 Zeilen wohlstrukturierten und perfekt dokumentierten Quelltexts lesen sich wesentlich leichter als 100 Zeilen eines völlig konfuses und undokumentierten Machwerks.

200 Zeilen aber sind noch vollkommen im Rahmen, im Zweifelsfall veröffentliche den Quelltext einfach, man wird Dir schon sagen, wenn man den Quelltext für zu lang erachtet.

[Jackaroo]

@lunar: Deine Antwort hilft mir weiter. Ich wollte nur ein Gefühl für Grössenordnungen haben.

Damit sind meine Fragen vorerst beantwortet. Ich vergrabe mich jetzt, um mein Progrämmle in epischer Breite mit Kommentaren zu versehen. Immer nach dem Motto: "Was hat sich der Autor wohl dabei gedacht?"

Soll ich das Thema nun wieder löschen?

Grüssle

[lunar]

@Jackaroo: Kommentare „epischer Breite“ sind nun wiederum zu viel des Guten Der Quelltext sollte unter den Kommentaren nicht untergehen, kommentiere nur, was des Kommentars bedarf.

Mach Dir aber nicht zu viele Gedanken, wie es „richtig“(TM) geht, sondern veröffentliche den Quelltext einfach dann, wenn Du ihn für halbwegs anständig hältst, im Zweifel lieber früher als später. Man wird Dich auf Fehler oder Unklarheiten schon hinweisen, zwar nicht immer allzu freundlich, aber doch stets kompetent

Themen werden in diesem Forum nur selten geschlossen, und fast nie gelöscht (abgesehen von Spam). Und wieso sollte dieses Thema gelöscht werden? Für Personen, die in diesem Forum neu sind, und dasselbe Anliegen haben, ist es doch ungemein hilfreich.

[Leonidas]

Themen werden in diesem Forum nur selten geschlossen, und fast nie gelöscht (abgesehen von Spam).

Zudem man als User threads sowieso nicht löschen kann. Man kann nur seine Beiträge bearbeiten und den Text löschen, aber das wird als extrem unhöflich angesehen.

[Jackaroo]

@lunar: "Epische Breite" war nicht so ganz ernst gemeint.

@Leonidas: Gott sei Dank, dann kann ich auch nichts kaputt machen.

Und nun muss ich mich wieder mit meinen Programmkommentaren beschäftigen. Es ist noch kein Schriftsteller vom Himmel gefallen.

Grüssle

P.S.: Dies Thema droht sich mit diesem Beitrag in der Beliebigkeit zu verlieren. Ab jetzt halte ich dazu meinen Mund. Versprochen!

[cofi]

P.S.: Dies Thema droht sich mit diesem Beitrag in der Beliebigkeit zu verlieren. Ab jetzt halte ich dazu meinen Mund. Versprochen!

Metadiskussionen und Diskussionen die sich aus dem Thread ergeben aber off-topic sind, sind hier ganz normal und nicht deine Schuld Solange du nicht ausfallend wirst gibt es hier keinen Grund den Mund zu halten.