Author:  Chris Seguin Software
Release Notes
Download
Contributors

Previous Page

Software::Pretty Printer

Next Page

PrettyPrinter

The first piece of software is a pretty printer for Java. It reads a java file or a directory structure containing java files. It reformats the code and inserts javadoc comments where they are missing.

This new version takes a look at the name of the method. If the method is a setter or getter, it takes an intelligent stab at filling in the javadoc comments, based on the name of the method, the class, and whether the method is static or not.

If the method is named run or it appears to be the main program, the javadoc comments are also generated appropriately. The exact words in the default descriptions for all methods are located in the pretty.settings file.

This software is the ability to set the level of protection that the system inserts javadoc comments. For instance, if the user of this program only wants javadoc comments for public methods and public fields, the user sets the method.minimum level to be public in the pretty.settings file.

A feature that is provided is a GUI that allows you to edit the pretty printer configuration with a GUI. To use the GUI, adjust the values and select save from the menu. When you save the file, it reformats the code in the right hand side.

For Elixir and JBuilder, this configuration editor is a menu item. For people using JRefactory as a command line tool, the command line is:
java org.acm.seguin.tools.install.PrettyPrinterConfigGUI

Alternatively, you can edit the pretty.settings file directly. The location of the pretty.settings file depends on the way you are using the pretty printer. In general, it is in your home directory.

Previous Page

Last Modified: November 28, 2000

Previous Page