C/C++ Style-Guide
Verfasst: Do Mai 05, 2011 1:33 pm
Ich möchte hier mit euch mal einen Style-Guide diskutieren.
Wie würdet ihr die Klasse formatieren?
Sollte ein Getter auch getMember() heißten oder nur member()?
Inbesondere interessiert mich hier die Namen der Variablen. Groß- oder Kleinschreibung? javaNotation, CamelCase, CAPITALS, getMember(), GetMember(), get_Member() oder get_member()?
Sollen Membervariablen wie hier Member1 lieber mMember1 oder _Member1 oder member1_ heißen?
Sollen Funktions-Parameter Präfixe haben, wie das 'a' bei staticFunction()?
Was nutzt ihr - und vor allem - warum macht ihr es so?
Ich möchte hier einen logischen Style-Guide entwickeln - der auch mal vernünftig begründet werden kann.
Entsprechend werden die C-Quellen hier angepasst und ich werde mein komplettes Framework danach umbauen.
Aber dafür möchte ich halt einen durch und durch durchdachten und logischen Styleguide auf proggen.org beschreiben können.
Ggfs. einfach mal den Quelltext so formatieren, wie ihr ihn formatieren würdet - und beschreiben, warum ihr Änderungen gemacht habt.
Code: Alles auswählen
class Klassenname : public Basis1
, public Basis2
{
private:
int Member1;
public:
int Member2;
int const Konstante1;
Klassenname( int member1, int member2 )
: Member1( member1 )
, Member2( member2 )
{
DoSomething();
}
private:
void DoSomething();
unsigned int PrivateMethod( unsigned int a, unsigned int b );
protected:
unsigned int ProtectedMethod( unsigned int a, unsigned int b );
public:
unsigned int PublicMethod( unsigned int a, unsigned int b );
unsigned int member1() { return Member1; }
void setMember1( int m1 ) { Member1 = m1; }
unsigned int getMember2() { return Member2; }
};
unsigned int Klassenname::PrivateMethod( unsigned int a, unsigned int b )
{
unsigned int result;
result = a + b;
return result;
}
static unsigned int staticFunction( unsigned int aSummand1, unsigned int aSummand2 )
{
unsigned int result;
result = aSummand1 + aSummand2;
return result;
}
unsigned int GlobalVariable;
Sollte ein Getter auch getMember() heißten oder nur member()?
Inbesondere interessiert mich hier die Namen der Variablen. Groß- oder Kleinschreibung? javaNotation, CamelCase, CAPITALS, getMember(), GetMember(), get_Member() oder get_member()?
Sollen Membervariablen wie hier Member1 lieber mMember1 oder _Member1 oder member1_ heißen?
Sollen Funktions-Parameter Präfixe haben, wie das 'a' bei staticFunction()?
Was nutzt ihr - und vor allem - warum macht ihr es so?
Ich möchte hier einen logischen Style-Guide entwickeln - der auch mal vernünftig begründet werden kann.
Entsprechend werden die C-Quellen hier angepasst und ich werde mein komplettes Framework danach umbauen.
Aber dafür möchte ich halt einen durch und durch durchdachten und logischen Styleguide auf proggen.org beschreiben können.
Ggfs. einfach mal den Quelltext so formatieren, wie ihr ihn formatieren würdet - und beschreiben, warum ihr Änderungen gemacht habt.