search

RobotCasserole1736 / RobotCasserole2017

Robot Casserole robot source code for the 2017 FRC game, First Steamworks.
MIT License
0 stars 0 forks source link

Code Conventions #88

Closed imdunne8 closed 7 years ago

imdunne8 commented 7 years ago

I don't feel like this is a place for any kind of strict coding conventions, but Java has a very short list of very simple conventions that everybody should read and try their best to follow.

Java Coding Conventions

gerth2 commented 7 years ago

I believe eclipse has ways of enforcing this as well, I know I set up google formatting standards at one point... not sure if it's detailed enough to catch naming conventions though.

http://checkstyle.sourceforge.net/ is one option for enforcing it.

imdunne8 commented 7 years ago

Nah, Eclipse enforcement is probably way more than is really necessary and people should generally use everything in the link I posted in any modern programming language. It only takes about two minutes to read through the rules and examples in the link, and hopefully that will get everyone doing these by default with no need for IDE level enforcement. I'll check that everybody has read this over the next couple meetings and then close this issue out.

If anyone is interested in going quite a bit further, the NASA JPL Java Coding Standard document is a great resource (document links in it aren't working for me). It's unrealistic to expect anywhere near this level of standards for new programmers though.