Codeformatierung

Hier kann alles mögliche diskutiert werden. Themen zu Purebasic sind hier erwünscht.
Flames und Spam kommen ungefragt in den Mülleimer.
Tibor
Beiträge: 42
Registriert: 29.08.2004 03:25
Wohnort: Mittelerde, südlich der großen Grasplantagen

Codeformatierung

Beitrag von Tibor »

Ich habe heute einen kleinen Text über Codeformatierung geschrieben.
Er richtet sich eigendlich nur an blutige Anfänger,
es wär aber nett wenn ihn auch ein paar Fortgeschrittene lesen könnten,
um auf eventuelle Fehler hinzuweisen.


Tibor's Erklärung der Codeformatierung

Da viele Anfänger meist nichts über die Codeformatierung wissen,
habe ich mich entschlossen die kurze Abhandlung zu schreiben.
Als erstes sollte man wissen, das die Formatierung des Quellcodes der besseren Lesbarkeit dient.
Die Grundregel besagt:
"Zeilen werden eingerückt, wenn sie durch einen Anfangs- und Abschlussbefehl zu einem Block zusammen gefasst sind".
Unter PureBasic Programmierern hat es sich eingebürgert das diese Einrückung 2 Zeichen beträgt.
Codeblöcke die von folgenden Befehlen eingefasst sind werden im allgemeinen eingerückt:

If : Else : EndIf
Select : EndSelect
Repeat : Until/ForEver
While : Wend
For : Next
ForEach : Next
Procedure : EndProcedure
Structure : EndStructure
Interface : EndInterface
Label: : Return
StartDrawing() : StopDrawing()
StartSpecialFX() : StopSpecialFX()
Start3D() : Stop3D()
StartPrinting() : StopPrinting()


Ein Beispiel:

Code: Alles auswählen

Procedure PrintDasA(a)
  PrintN("a = "+Str(a))
EndProcedure

OpenConsole()
a = Val(Input())
PrintN("")
If a = 1
  PrintN("a = 1")
ElseIf a > 1 And a < 4
  Select a
    Case 2
      PrintN("a = 2")
    Case 3
      PrintN("a = 3")
  EndSelect
Else
  If a = 4
    PrintN("a = 4")
  Else
    PrintDasA(a)
  EndIf
EndIf
Repeat      
  Delay(10) 
Until "" <> Inkey()
Im Forum sollte man außerdem noch den gesammten Code mit (code) (/code) umrahmen.
Statt der runden Klammern bitte eckige verwenden. []
Dadurch setzt sich der Code auch noch farblich vom restlichen Text ab.
Benutzeravatar
freedimension
Admin
Beiträge: 1987
Registriert: 08.09.2004 13:19
Wohnort: Ludwigsburg
Kontaktdaten:

Re: Codeformatierung

Beitrag von freedimension »

Vielleicht noch ein Hinweis dass das bei diesen Kombinationen nicht immer so sein muss (da nicht unbedingt auf gleicher Ebene), und dass es daher hier auch noch Schwierigkeiten gibt mit dem automatischen Einrücken bei jaPBe (+ link auf jaPBe ;-) ).
Tibor hat geschrieben: Label: : Return
StartDrawing() : StopDrawing()
StartSpecialFX() : StopSpecialFX()
Start3D() : Stop3D()
StartPrinting() : StopPrinting()
Beginne jeden Tag als ob es Absicht wäre!
Bild
BILDblog
Sebe
Beiträge: 585
Registriert: 11.09.2004 21:57
Wohnort: Europa
Kontaktdaten:

Beitrag von Sebe »

Statt zwei Leerzeichen würde ich ein Tab empfehlen. Aber das ist nur meine Meinung.
Tibor
Beiträge: 42
Registriert: 29.08.2004 03:25
Wohnort: Mittelerde, südlich der großen Grasplantagen

Beitrag von Tibor »

Sebe hat geschrieben:Statt zwei Leerzeichen würde ich ein Tab empfehlen. Aber das ist nur meine Meinung.
Ein Tab hat keine fest definierte Zeichenlänge.
Bei QBasic z.B. hat das Tab standardmäßig 8 Leerzeichen.
Als Fred den PB Editor schrieb fand er es am besten 2 Leerzeichen zu nehmen.
Und diesen Wert habe ich übernommen. ;)

@freedimension
Du hast recht, aber ich sehe meinen Text als Leitline und nicht als Norm.
Benutzeravatar
freedimension
Admin
Beiträge: 1987
Registriert: 08.09.2004 13:19
Wohnort: Ludwigsburg
Kontaktdaten:

Beitrag von freedimension »

Tibor hat geschrieben:
Sebe hat geschrieben:Statt zwei Leerzeichen würde ich ein Tab empfehlen. Aber das ist nur meine Meinung.
Ein Tab hat keine fest definierte Zeichenlänge.
Bei QBasic z.B. hat das Tab standardmäßig 8 Leerzeichen.
Als Fred den PB Editor schrieb fand er es am besten 2 Leerzeichen zu nehmen.
Und diesen Wert habe ich übernommen. ;)

@freedimension
Du hast recht, aber ich sehe meinen Text als Leitline und nicht als Norm.
1. Leerzeichen sind besser. (<- man beachte den PUNKT)
2. Leitlinie hin oder her, Anfänger sind immer übergenau und nehmen alles was in einem Tutorial steht für bare Münze. Wenn da steht, immer einrücken bei StartDrawing... und das will in jaPBe partout nicht funktionieren kommt dann halt eben schnell frust auf :D
Beginne jeden Tag als ob es Absicht wäre!
Bild
BILDblog
Antworten