Coding-Stil und dessen Bedeutung

[kartoffel]

Hallo meine Lieben ,

in letzter Zeit habe ich vermehrt Quellcode gelesen und dabei bemerkt,
dass in den meisten Fällen der Stil ziemlich Schauderhaft ist.
Deshalb werde ich in diesem Thread versuchen, Tipps zum stilvollen Coding
zu sammeln.

Bitte helft mit und schickt mir eure Tipps und Tricks per PN.
Jetzt geht es aber los:


Tipps und Tricks zum richtigen Coden

		Code sinnvoll formatieren! (klick)		
Code sinnvoll formatieren

Dieser Punkt ist sehr einfach zu nutzen, hat aber extreme Wirksamkeit:

Anstatt Code einfach Zeile für Zeile untereinander zu schreiben,
macht es Sinn, Leerzeilen, Leerzeichen und Tabs einzustreuen,
um den Text zu strukturieren.

Zum Beispiel ist dieser Code

                                function funktion1(parameter)    local variable    if variable == 1 then        befehl1    else        befehl2    endend function funktion2(parameter)    local variable    if variable == 1 then        befehl1    else        befehl2    endend 
sehr viel lesbarer als

                                function funktion1(parameter)local variableif variable == 1 thenbefehl1elsebefehl2endendfunction funktion1(parameter)local variableif variable == 1 thenbefehl1elsebefehl2endend 	

		Variblennamen vergeben! (klick)		
Variblennamen

Ein weiterer einfacher Punkt, der eigentlich offensichtlich sein sollte,
der aber immernoch oft vernachlässigt wird.

Gebt euren Variablen sinnvolle Namen, wie

                                playerID = ply:UniqueID 
anstatt

                                A = ply:UniqueID 
Das hat den Effekt, dass ihr euch besser an Namen, Inhalt und Funktion der Variable erinnern könnt.
	

		Kommentare benutzen! (klick)		
Kommentare benutzen

Lua bringt, wie andere Skriptsprachen auch, eine Kommentarfunktion mit,
damit ihr eurem Code Anmerkungen und Erläuterungen hinzufügen könnt.
Dies hilft anderen, die aus eurem Code lernen wollen, den Code zu verstehen,
und auch ihr werdet auch nach Jahren noch euren Code verstehen können.

Für Kommentare gibt es folgende Möglichkeiten:

                                --Einzeiliger Kommentar 
                                /*Kommentar über mehrere Zeilen,sehr nützlich*/ 
                                --[[Alternativer, mehrzeiligerKommentar]] 	

[makkurona]

Bevor ich mir von jemandem vorschreiben lasse, wie ich meinen Stil zu gestalten habe, höre ich lieber auf.

[WeltEnSTurm]

soll ja auch 1-line coder geben die zurechtkommen.

[kartoffel]

Heisst aber nicht, dass dieser Code dann auch leicht lesbar ist.
Außerdem ist das hier ein Leitfaden und kein Regelwerk.

[Pac_187]

Bevor ich mir von jemandem vorschreiben lasse, wie ich meinen Stil zu gestalten habe, höre ich lieber auf.

Wer schreibt dir denn hier bitte vor wie du zu coden hast?

Es sollen lediglich Tipps sein die dazu beitragen,
dass auch noch andere Entwickler durch deinen Code durchsteigen
und nicht irgend ein "Wollknäuel" vor sich haben....

[makkurona]

Ich wollte es nur anmerken.
Ich persönlich kommentiere und rücke ein. Das Variablennamen ersichtlich sein sollten ist eigentlich klar. So wie man es auch machen sollte. Aber ich finde, dass jeder seinen eigenen Stil finden sollte.

In Multientwicklerprojekten, ist das wieder etwas anderes, dann sollte man gewisse Grundregeln festmachen, aber ansonsten... Naja. Ich weiß nicht. *zwinker*

[kartoffel]

Wie gesagt, es sind nur Tipps...
Keine Regeln, solche aufzustellen wär unverschämt.

[kycro]

Diese Richtlinien haben mir sehr geholfen (und LuaEdit, habe vorher im Windows Editor gecodet)

[Scarecrow]

Auf der anderen seite wird sowas natürlisch absichtlich gemacht denn man soll den code ja nicht immer nachvollziehen können. Nicht jeder Depp sollte sich daraus einen Vorteil ziehen, schon garnich wenn alles open source ist (ok widerspruch in sich aber ***** =).

[BennyG]

Auf der anderen seite wird sowas natürlisch absichtlich gemacht denn man soll den code ja nicht immer nachvollziehen können. Nicht jeder Depp sollte sich daraus einen Vorteil ziehen, schon garnich wenn alles open source ist (ok widerspruch in sich aber ***** =).

Den Stimm ich voll zu

Ich Rücke zwar auch ein,aber ich schreibe extra keine Kommentare,wenn doch, dann nur in einer seperaten TextFile,die ich nicht mitveröffentlichen werde.
Wenn man sich doch dieses mit Script-Kiddys überflutete Gmorg anschaut,versucht man schließlich recht häufig den Code so unverständlich wie möglich zu machen.
(Siehe NUKE_V10,NUKE_V2231,NUKE_SUPER_V152_FIX etc)