welcher Code?^^

Poste doch mal nen Code, von dem gesagt wurde, er sei unsauber. Dann können wir dir sicher sagen, ob dem so ist bzw. was daran unsauber ist.

Nunja unsauberer Code wäre z.B. sowas



Da er nicht Disposed wird

richtig:


Ebenfalls unsauber is unsinniges Variablen rumhantieren



da man Variablen direkt bei der Deklaration zuweisen kann und ebenfalls ReadToEnd() direkt an die Text-Eigenschaft zuweisen.

Es gibt viele Anzeichen von unsauberem Code, so pauschal kann man jetzt nicht die unsauberen Dinge auflisten.
Du müsstest uns schon ein wenig Code zeigen, von dem du von anderen Leuten hörtest, dass er unsauber sei.

Es gab mal irgendwo einen Thread zum sauberen/unsauberen Code, aber wie immer finde ich ihn über die interne Suche nicht

Edit: dank Google URL Suche doch gefunden [VB.NET] Beispiele für guten und schlechten Code (Stil)

Patrick1993 schrieb:

Was soll daran unsauber sein ??
Soviel ich hier gelesen und verstanden habe soll ich nicht Dim sondern Using nutzen.

Naja, gut das bisserl Code zu einzustufen ist natürlich schwierig, aber folgende Kritikpunkte könnte ich mir vorstellen (soll nicht heissen das es meine wären):

1. Using anstatt Dim

2. Direkte String-Zuweisung ... also string = "Mein Inhalt" ... viele schwören darauf solche konstanten Zuweisungen als Class-Constante zu deklarieren

3. Doppelte identisch Anweisung (MessageBox.Show) , besser Variable strMsg mit Text zu befüllen und dann nach dem If-Construct die Anweisung MessageBox.Show(strMsg) auszuführen ... aber da die Anweisung ja eh nur zum testen drinnen ist, ist es an sich eh egal

4. Einige empfinden es bereits als unsauberen Code, die Funktion direkt in den Event-Handler des Controls rein zu schreiben. Oftmals wird als guter Stil angesehen dieses in eine separate Funktion zu kapseln und aus dem Event-Handler dann nur die Funktion aufzurufen, bzw. solche Standard-Hilfsvorgänge die man immer wieder mal an verschiedenen Stellen im Code brauchen kann gleich in eine eigene Klasse auszulagern.

5. Fehlende Kommentare ... kurz ein wieso und warum dazu wird von Vielen als zwingend für einen sauberen Code angesehen

Da es sich dabei aber offensichtlich um eine reine Testfunktion handelt, kann ich die Kritik eh nicht so ganz nachvollziehen und als einziger Punkt würde tatsächlich nur Using statt Dim bleiben. Allerdings einem Anfänger das dann als unsauberen Code vorzuhalten finde ich nicht wirklich nachvollziehbar ... kleiner Hinweis "Guck mit Using fährst Du aus dem und dem Grund besser" und gut ist.

Gruß

Rainer

Das mit dem Using macht bei deinem Beispiel Sinn, weil der OpenFileDialog ein Control ist, das in den Speicher geladen wird und nach Benutzung durch End Using halt wieder freigegeben wird.

Mit Dim ofd As New OpenFileDialog bleibt es halt noch, was aber unnötig ist, da es vermutlich net ständig gebraucht wird.
Deswegen macht eine Anweistung wie Using Meintext as string = "Blubb" vermutlich weniger Sinn, weil du wahrscheinlich mit diesem String noch woanders arbeiten willst. Und nach End Using existiert der halt net mehr.

Ich hoffe mal die Erklärung macht Sinn. Sonst berichtige mich wer.^^

//Edit

Wenn ich innerhalb des Using Blocks eine Variable deklariere, kann ich auf diese nach End Using net mehr zugreifen.

Öhem ... Using macht nur bei Objekten die auch eine Dispose-Methode haben Sinn (und sind auch nur bei denen ohne Compiler-Mecker möglich^^). Normale Variablen deklarierst Du natürlich nach wie vor mit Dim.

Dispose-Methode ist die Methode einer Klasse/eines Objektes das belegte Ressourcen explizit wieder frei gibt und durch das Konstrukt Using-End Using wird die Methode Dispose explizit durch End Using ausgelöst.

Mit der String-Übergabe hast Du auch falsch verstanden.

Du befüllst den String direkt im Code mit einem Text von Dir. Hier schwören viele drauf eine Private Const die klassenweit gültig ist zu deklarieren und ihr den String zu zu weisen. Später im Code direkt wird dann nur noch die Constante zugewiesen und kein handgeschriebener Text mehr.

Falls Du den Part nicht verstehst, dann gaaaanz drigend Grundlage erarbeiten ... Gültigkeitsbereich, Sichtbarkeit, Lebensdauer von Variablen und die unterschiedliche Variablentypen wie Static, Const etc.. In dem Sinne gleich auch mitlernen was der Unterschied zwischen einer Wert- und einer Verweisvariable ist. Je schneller Du das intus hast desto besser für Dich.

Patrick1993 schrieb:

Dies habe ich nicht zu 100% verstanden

Du hast Deinen Code direkt in das Click-Event reingeschrieben. Das was ich gemeint habe, ist das Du eine eigene Private Prozedure für den Aufruf des Open-File-Dialogs anlegst (z.B. mit Namen GetFileFromDialog) und dann steht im Click-Event dann nur noch Call GetFileFromDialog.

Patrick1993 schrieb:

'also immer Kommentare setzen bevor Code'

Quasi richtig. Ich habe früher tatsächlich zuerst die Kommentare zum Code-Ablauf und was wo und wieso passiert geschrieben und dann erst den Code passend zu den Kommentaren.

Aber das war noch zu Zeiten wo es nicht üblich war Code-Abläufe/-Verzweigungen in Flow-Charts vorzuzeichnen und man auch prozedural und nicht objektorientiert programmiert hat.

Patrick1993 schrieb:

--
Dies wurde gemacht um sicher zu gehen das ich es auch verstanden habe bevor ich anfange Programme zu basteln und Fehler einbaue.
Das mit dem Dim war in den Tutorials eingebaut somit wusste ich nicht das es als "unsauber" gezählt wird.

Das ist natürlich sehr sinnvoll. In dem sinne empfehle ich Dir auch Dich mal mit Notation/Präfixen auseinander zu setzen ... oder salopp: Saubere Benamsung. Mir persönlich liegt ungarisch und Kamelschreibweise am ehesten.

Edit: Ach ja ... gewöhn Dir am besten gleich an NUR mit Option Strict On zu arbeiten.

Denke aber da werden auch noch andere Tipps für Dich haben.

Edit:

@ Unwesen

Using setzt immer vorraus das das damit angesprochene Objekt auch über eine Dispose-Methode verfügt. Probiere mal eine Klasse mit Using zu nutzen in der Du nicht die IDisposable Schnittstelle eingebaut hast ... das geht schief.

Gruß

Rainer

raist10 schrieb:

In dem sinne empfehle ich Dir auch Dich mal mit Notation/Präfixen auseinander zu setzen ... oder salopp: Saubere Benamsung

Zu diesem Thema empfehle ich:
msdn.microsoft.com/de-de/library/ms229002(v=VS.80).aspx

Danach kannste dich richten: [VB.NET] Beispiele für guten und schlechten Code (Stil)



link_275

@link: [Allgemein] Sauberer Code *g*

Sorry hab' Ich wohl überseh'n :-/



link_275