[Jwall-developers] Code cleanup

[Zachary L. <za...@th...>]

Dirk made some good suggestions and so I am posting them to the list. 
Everyone, please do your best to follow these recommendations, as it will
make it easier for all of us to work on this together...
PS - The CVS restructure won't be happening until the code settles down a
bit.  Hopefully in the next week or 2.
ZL


Hi folks,

as you might have noticed, there is a lot of code cleanup and reorganization
in progress. And we need your help for that.

Step one is should take just a few minutes of your time. Right now there are
many //todo: comments spread all over the place. Some IDEs (IntelliJ,
Eclipse) support the programmer and add them into a special view that makes
theam easily accessible. In IntelliJ it is also possible to define
additional markers.

I'd like to propose the usage of the following markers:

(1) // todo (username)
(2) // fixme (username)
(3) // lang (username)
(4) // res (username)

Please do append your username. It makes filtering for your own todos a lot
easier. Other programmers also know that somebody wanted to work on that
part of the code.

Explanation:

(1) stands for missing functionality. Example: You'd put a todo marker into
an actionPerformed method because it does not handle all buttons

(2) stands for broken functionality. You use that marker if there is some
code but you are not 100% sure whether it really works in all cases.

(3) the right way is to add an entry in the resource file whenever you use a
string. But that's tedious work... But if you don't do it right away you'll
forget about it. Please, do add at least this marker so that we can fix
those problems from time to time.
   This needs to be done for every string that is visible on screen! Nothing
looks worse than a translation that is only halfway complete! Don't forget
things like "(unsaved)" that is added to the title bar if something was
modified and so on. You can also add the name of the property after the
marker. That makes it easier for the person doing the translation later on
because he doesn't need to search through your code to find which names you
use for your resources.
   Please note: Your functionality _must not_ depend on strings (e.g. check
which button was pressed by checking for its name) as those change because
of localization.

(4) resource loading will change! Please mark all places on your code where
you need images! That'll make it easier to find broken code.

After marking all problems we'll then try to solve as many of them after the
reorganization of the code.

Thank you for your cooperation! Feel free to ask Zack or myself if there are
any questions.