Package com.ibm.xtools.patterns.framework.java
[Mariana Alupului] - Package specification template added in source code (package.html).
| Class summary |
|---|
| PatternMetatype | The pattern metatype class to use when dealing with Java classes and types. |
| PatternMetatype.JavaMetatype | This class is the common implementation for a pattern metatype that
represents a java class. |
Package com.ibm.xtools.patterns.framework.java Description
[Mariana Alupului] - Package specification template added in source code (package.html).
Package Specification
Sun Microsystems suggests creating an HTML file called package.html for each package, putting the file into the appropriate directory for the package.A better name would be the fully qualified name of the package, postfixed with .html, so that you do not have to worry about accidentally overwriting one package documentation file with another.Documenting a PackageYou should maintain one or more external documents that describe the purpose of the packages developed by your organization. For each package you should document:The rationale for the package. Other developers need to know what a package is all about so that they can determine whether or not they want to use it, and if it is a shared package whether or not they want to enhance or extend it.The classes in the package. Include a list of the classes and interfaces in the package with a brief, oneline description of each so that other developers know what the package contains.This contains a copyright statement. Obviously, if you are from a different company, you would supply your own copyright statement.