[OBJ] Coding - Coding standard (old)

[Hyronymus]

ChrisCF once pulled a coding standard of the net and I have been busy converting it to our new homepage. Some utter crap has been removed but the core issues remain. The coding group needs to evaluate the current coding standard, when needed add to or edit it and finally accept it.

The Coding Standard can be found here.

Members: Grunt, Mek, Pjaytcy, Uzurpator

[Zuu]

Conventions

The use of the word shall in this document requires that any project using this document must comply with the stated standard.
The use of the word should directs projects in tailoring a project-specific standard, in that the project must include, exclude, or tailor the requirement, as appropriate.
The use of the word may is similar to should, in that it designates optional requirements.

Seams like the words that are being defined are missing.

[Hyronymus]

The words are shall, should and may Zuu.

[DaleStan]

They really should be quoted, then:

The use of the word "shall" in this document requires that any project using this document must comply with the stated standard.
The use of the word "should" directs projects in tailoring a project-specific standard, in that the project must include, exclude, or tailor the requirement, as appropriate.
The use of the word "may" is similar to "should", in that it designates optional requirements.

[Hyronymus]

Gald to see the evaluation works . DaleStan, you're joining TE too ?

[DaleStan]

Currently, I'm mostly watching, but I suppose that may change.

[Hyronymus]

That could mean 2 things: you stop watching or you join. We'll see in time .

[Hellfire]

I just noticed something: there is no indentation in the code samples! I recommend chaning samples like:

Code: Select all

class NameOneTwo
{
public:
int StartYourEngines(
Engine& rSomeEngine,
Engine& rAnotherEngine);
}

Into something like:

Code: Select all

class NameOneTwo
{
public:
  int StartYourEngines(
    Engine& rSomeEngine,
    Engine& rAnotherEngine);
}

(Feel free to change according to your own liking. )

[Hyronymus]

Ever tried adding it in a css document, Hellfire . But it's worth considering.

[Hellfire]

The two keywords here are "Fixed width font" and "&nbsp's."

For example:

Code: Select all

<p class="code">
class Something {<br>
&nbsp; int member1;<br>
&nbsp; int member2;<br>
&nbsp; void method(int parameter);<br>
}</p>

Will give, when a proper stylesheet is applied:

Code: Select all

class Something {
  int member1;
  int member2;
  void method(int parameter);
}

[DaleStan]

I thought the magic words were "<pre>" and "</pre>"?

[Hellfire]

<pre> is unformatted.. The result will be the same though.

[Hyronymus]

Anything that needs to be added to the coding style guide (and I don't mean format stuff).

[PJayTycy]

I have never worked on a program that had a "coding style" requirement, I've always done it my way, so I absolutely can't comment on this. Ofcourse, I could say what's different from what I usually do, but that doesn't get us any further, because my formatting rules don't get any better than this:

I usually just follow whatever indentation rules the development environment is best automated for and name my variables/functions however I like them (ie underscores, capitalization, ...).

[Hyronymus]

I hope you can imagine where it would lead the code to if everyone in the coding team did that, Pjaytycy .

[PJayTycy]

I hope you can imagine where it would lead the code to if everyone in the coding team did that, Pjaytycy .

Yes, maybe it wasn't so obvious, but I posted that as the reason why I wouldn't comment on this

Topic locked, a final coding style is chosen (15112006).