Each Java file must have a complete and useful type comment. Type comments must come after all import statements, and before the start of the class.
Figure 4.1. Type Comment
/** * A useful description of the class or interface, especially covering * how it is used, and what other classes or interfaces it interacts with. * * @author Your Name * @version $Id$ * @since Version */ |
The Version should be replaced with the numeric version number of the Tapestry release the type will first appear in. This is the minor release number; for example, a change introduced in release 2.3-beta-3 would be identified as 2.3.