|
StyleGuide
Style guide for hand written code.
Until we can get something more specific posted, we're borrowing GWT's Style Guide. RealityThe code as imported from Source Forge is not formatted according to the style we specify is this here document. Code will be reformatted as is it change (or if someone goes nuts and reformats all of the old code). Exceptions and Compulsive RestatementsAcronyms and AbbreviationsAcronyms and abbreviations should all be in camel case.
Javadoc
Line LengthLine length is limited to 80 characters. The following exceptions apply:
ASCII ArtifactsDo not put any "magic markers" in the files. E.g. // ------------------------------------------------- Private Variables Do not use "ASCII Art" indentation. It doesn't survive refactoring! Do public SomeLongClassNameThatIsTooLong getThatLongThing(AnotherLongClassName another,
SomeOtherLongClassName other, String name) {
// ...
}Don't public SomeLongClassNameThatIsTooLong getThatLongThing(AnotherLongClassName another,
SomeOtherLongClassName other,
String name) {
// ...
}
|
Sign in to add a comment