While comments are certainly an important part of code documentation, and become much appreciated later on during maintenance and support phases of an application, they can be quite tedious to write, particularly in cases where you are documenting the obvious. In some situations you may be able to get away without writing comments for these types of methods, but in some situations your IDE or Javadoc report may still flag those methods as missing Javadoc comments and so it’s best to put them in anyway.

JAutodoc is a super Eclipse plugin for assisting you with writing comments. It comes with customizable method prefix mappings to comment phrases. For example, if your method begins with ‘add’ the phrase ‘Adds the’ will be placed in the comment. Thus, if the method name was ‘addEmployee’ the comment text would be ‘Adds the employee’. If the method were ‘isActive’, the method text becomes ‘Checks if is active’. All of the mappings are customizable from the plugin properties.

It can be set to use the Eclipse comment formatter, to replace the existing Javadoc or to complete it, as well as optionally add a todo annonation to it for future review. It fills out all the parameters passed and return parameters as well.

You can highlight an individual method and right click and choose JAutodoc from the menu, or select the entire source of the class and complete all the javadocs. It saves a lot of time getting the skeleton of your javadoc comments in place, allowing you to focus your commenting time and energy on writing meaningful descriptions where necessary.

To read more about the plugin and download it, see the JAutodoc web site.

If you frequently want to switch between your local development instance of your web application, and the production version, or perhaps another version like an integration or QA installation, the Server Switcher Firefox plugin may be useful to you. With this plugin, you simply assign both URLs to each other in the Options tabe for the plugin and an icon will appear in the URL field of your browser. Clicking it will toggle you between the two URLs.

For example, if I was running an application on my local machine at http://localhost:8080, and the live version was at www.brianburridgecom, I would enter each in the plugin’s options under Development Server and Live Server respectively. When I got to either web site, I get an icon. A construction hat when working locally, and a server when on the “live” server.

The plugin supports ports, subdirectories, local files (specified with file://). Ctrl-Shift-X can be used to toggle with the keyboard.

I have found this plugin very useful during web site development. I don’t always have the “live” server set for a true production install, but instead to switch between my local development instance, and an integrated development server to perform some QA on both and compare the differences between them.

The plugin can be found here.

I love using Gmail and Google Calendar. The only problem I’ve had with Google Calendar, is that I forgot to check it, and then forget something I scheduled. Here is a greasemonkey script, and a tutorial for setting it up, that places your Google Calendar agenda on your GMail in the left hand side. Fantastic idea, and now makes it much more likely I’ll not forget my scheduled events, since I’ll see them all day long.

See the tutorial.