XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <mockdoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) borland (@bes) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mockobjects (@mock) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) oracle (@oc4j) orion (@orion) pramati (@pramati) sybase (@easerver) web (@web @jsp) webwork (@webwork) xdoclet (@xdoclet @doc) Feature Documentation Using Value Objects Advanced Maven Plug-in Merge Points Log4J Configuration IDE Integration Migration from EJBDoclet Ant 1.5 Troubleshooting Community Feedback Resources Tools Development Developer Guide Javadoc (API) Template Language (*.xdt) XJavaDoc Site Project Documentation Front Page Project Info Project Reports Development Process | ### Developer Guide #### New XDoclet Developer? Welcome! There are a variety of ways to participate. Regardless of how you choose to participate, we suggest you to join the mailing list first. Feel the irresistible urge to write quality code? Then join the XDoclet project team today (send an email to the xdoclet-devel mailing list)! #### Coding Conventions Below is a list of coding conventions that are specific to XDoclet, everything else not specifically mentioned here should follow the official Sun Java Coding Conventions . 1. Brackets that begin and end classes and methods should begin and end on a new line and should exist even for one line statements. 2. 4 space indent. NO tabs . Period. We understand that many developers like to use tabs, but the fact of the matter is that in a distributed development environment where diffs are sent to the mailing lists by both developers and the version control system (which sends commit log messages), the use tabs makes it impossible to preserve legibility. 3. JavaDoc MUST exist on all methods. If your code modifications use an existing class/method/variable which lacks JavaDoc, it is required that you add it. This will improve the project as a whole. 4. If you contribute to a file (code or documentation), add yourself to the authors list at the top of the file. Your sourceforge email address is preferred. Do not include the @ sign, as email spiders will put your email in spam lists. For java files the preferred Javadoc format is:
    @author <a href="mailto:user at domain.com">John Doe</a>
Thanks for your cooperation. #### Further Reading Architecture Branches and Tags CVS Directory Layout XDoclet 2 Design Planning