Styleguide?

Übersicht

BlitzMax, BlitzMax NG

Allgemein

	DaysShadow Betreff: Styleguide?	Sa, Aug 08, 2009 8:47 Antworten mit Zitat
Ja, wie der Titel schon sagt, gibt es eine Art Styleguide für BlitzMax? Ich weiß oft nicht wie ich den Code gestalten soll, sodass er einerseits für mich ordentlich lesbar bleibt andererseits aber auch für andere lesbar wäre. Momentan z.B. bin ich bei Types dazu übergegangen den Fields einen Unterstrich voranzusetzen, gefolgt von einem mit Kleinbuchstaben beginnenden Wort, das nächste Wort dann halt mit Großbuchstaben begonnen. So soll es ja bei diversen Sprachen gängig sein, sofern sie mit Klassen und Co. hantieren. Naja, wie macht ihr das? Das mit den Unterstrichen gefällt mir irgendwie nicht besonders wenn man auf die Member der Types zugreift und dann sowas -> "Type._member" zu sehen ist. Schlimmer wirds noch bei sowas -> "Type._member._member._member" usw. Ein paar Tipps wären nett Danke! MfG DaysShadow
Blessed is the mind too small for doubt

DaysShadow

Betreff: Styleguide?

Sa, Aug 08, 2009 8:47
Antworten mit Zitat

Ja, wie der Titel schon sagt, gibt es eine Art Styleguide für BlitzMax?
Ich weiß oft nicht wie ich den Code gestalten soll, sodass er einerseits für mich ordentlich lesbar bleibt andererseits aber auch für andere lesbar wäre.
Momentan z.B. bin ich bei Types dazu übergegangen den Fields einen Unterstrich voranzusetzen, gefolgt von einem mit Kleinbuchstaben beginnenden Wort, das nächste Wort dann halt mit Großbuchstaben begonnen.
So soll es ja bei diversen Sprachen gängig sein, sofern sie mit Klassen und Co. hantieren.

Naja, wie macht ihr das?
Das mit den Unterstrichen gefällt mir irgendwie nicht besonders wenn man auf die Member der Types zugreift und dann sowas -> "Type._member" zu sehen ist.
Schlimmer wirds noch bei sowas -> "Type._member._member._member" usw. Wink

Ein paar Tipps wären nett Wink

Danke!
MfG DaysShadow

Blessed is the mind too small for doubt

	hamZta Administrator Betreff: Re: Styleguide?	Sa, Aug 08, 2009 9:46 Antworten mit Zitat
DaysShadow hat Folgendes geschrieben: Das mit den Unterstrichen gefällt mir irgendwie nicht besonders wenn man auf die Member der Types zugreift und dann sowas -> "Type._member" zu sehen ist. Schlimmer wirds noch bei sowas -> "Type._member._member._member" usw. Man sollte ohnehin nur innerhalb eines Types auf dessen Member direkt zugreifen, von außen sollte man Methoden dafür benutzen (Getter/Setter). Leider gibts in BlitzMax kein Public/Private, also muss man sich einfach selbst dran halten Ich benenne meine Fields genau wie du (_thisIsAField) und finde das sehr übersichtlich, in Methoden kann man schnell unterscheiden was Parameter und was Fields sind. Ansonsten benenne ich generell alles nach dem "Camel Case"-Schema (s.o., "thisIsAField"). Typenamen beginnen mit "T" und danach ähnlich wie Fields, nur erster Buchstabe groß (TMyType). Man kann sich auch angewöhnen, private Methoden mit doppeltem Unterstrich zu versehen (__privateMethode) um deutlich zu machen, dass man diese Methode von außen in Ruhe zu lassen hat BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Type TMyType Field _thisIsAField:Int Method publicMethod(param1:Int) End Method Method __privateMethode(param1:Int, param2:Int) End Method End Type lg, hamZta
Blog.

hamZta

Administrator

Betreff: Re: Styleguide?

Sa, Aug 08, 2009 9:46
Antworten mit Zitat

DaysShadow hat Folgendes geschrieben:

Das mit den Unterstrichen gefällt mir irgendwie nicht besonders wenn man auf die Member der Types zugreift und dann sowas -> "Type._member" zu sehen ist.
Schlimmer wirds noch bei sowas -> "Type._member._member._member" usw. Wink

Man sollte ohnehin nur innerhalb eines Types auf dessen Member direkt zugreifen, von außen sollte man Methoden dafür benutzen (Getter/Setter). Leider gibts in BlitzMax kein Public/Private, also muss man sich einfach selbst dran halten Wink

Ich benenne meine Fields genau wie du (_thisIsAField) und finde das sehr übersichtlich, in Methoden kann man schnell unterscheiden was Parameter und was Fields sind.

Ansonsten benenne ich generell alles nach dem "Camel Case"-Schema (s.o., "thisIsAField").

Typenamen beginnen mit "T" und danach ähnlich wie Fields, nur erster Buchstabe groß (TMyType).

Man kann sich auch angewöhnen, private Methoden mit doppeltem Unterstrich zu versehen (__privateMethode) um deutlich zu machen, dass man diese Methode von außen in Ruhe zu lassen hat Wink

BlitzMax: [AUSKLAPPEN]

Type TMyType
  Field _thisIsAField:Int

  Method publicMethod(param1:Int)
  End Method

  Method __privateMethode(param1:Int, param2:Int)
  End Method
End Type

lg,
hamZta

Blog.

	DaysShadow	Mo, Aug 10, 2009 6:29 Antworten mit Zitat
Hey, danke, Getter und Setter zu benutzen ist mal ein sinnige Sache, habs jetzt schon so benutzt und muss sagen dass mir der Code gleich viel besser gefällt Danke! MfG DaysShadow
Blessed is the mind too small for doubt

DaysShadow

Mo, Aug 10, 2009 6:29
Antworten mit Zitat

Hey, danke, Getter und Setter zu benutzen ist mal ein sinnige Sache, habs jetzt schon so benutzt und muss sagen dass mir der Code gleich viel besser gefällt Very Happy

Danke!
MfG DaysShadow

Blessed is the mind too small for doubt

Übersicht

BlitzMax, BlitzMax NG

Allgemein

Nach Oben

BlitzBasic Portal

Styleguide?

DaysShadow

Betreff: Styleguide?

hamZta

Betreff: Re: Styleguide?

DaysShadow