This page contains various thoughts about how the code should be written and organised.

Technologies to Use

• Languages used: We have all agreed to use Java to write all parts of the system.

• IDE: We should use Eclipse to write our code and manage the project.

Code Writing

• Code Layout: Each subsystem should reside in a separate Java package (not necessarily an Eclipse project), with shared code being in a package of its own.

• Code Style: Ideally we should follow some code convention. For Java, the official conventions seem like a good idea. But, let's be realistic. As long as we are not inventing something, we should be fine. If in doubt, use Eclipse's source code formatter (I will get cranky if you won't follow naming conventions though ~GL).

• Documentation: Be sure to use javadoc to document your code. Having a short but clear description for every function and class is a realistic target we should achieve.

• K.I.S.S.: The code should be as simple as possible. We can always refactor to get more complex solutions running.

World State Conventions