R – How to document your coding standards?

coding-stylestandards

What have you found to be the best way to publish your coding standards and why?

Best Solution

If you mean Style Guidelines - a Word document or PDF. IMO, this is something that is "set in stone", but on a per-project basis (if you see something that doesn't work, fix it for the next project, especially if it's late in the project and you have a ton of code that follows the existing style).

Related Solutions

Should a function have only one return statement

I often have several statements at the start of a method to return for "easy" situations. For example, this:

public void DoStuff(Foo foo)
{
    if (foo != null)
    {
        ...
    }
}

... can be made more readable (IMHO) like this:

public void DoStuff(Foo foo)
{
    if (foo == null) return;

    ...
}

So yes, I think it's fine to have multiple "exit points" from a function/method.

Java – Coding Conventions – Naming Enums

Enums are classes and should follow the conventions for classes. Instances of an enum are constants and should follow the conventions for constants. So

enum Fruit {APPLE, ORANGE, BANANA, PEAR};

There is no reason for writing FruitEnum any more than FruitClass. You are just wasting four (or five) characters that add no information.

Java itself recommends this approach and it is used in their examples.