Working with Java and XML documentation

One of the ways to create documentation for your java code is to use the 'javadoc' tool that comes along with your java SDK installation. Otherwise you can use documentation tools available from a third party like AurigaDoc.

This tool is java-XML-XSL based. With this tool you can convert your documentation into other formats like PDF, DHTML, FO, RTF, Java Help, and HTML Help. This tool keeps a single source and uses XSL to convert the XML document into other format using XSLT.

You can customize the transformation by using your own customized XSL file. There is an option to configure which XSL to use for the transformation. You can call this AurigaDoc tool from within your java classes or invoke it in command line.

Using the javadoc tool is very simple you have to write your documentation comments above the class or a field or constructor in a certain format. You have to start your comments with "/**" and then finish it with "*/". That's it. then you have to run the javadoc tool to generate the documentation.

FREE Subscription Subscribe to our mailing list and receive new articles through email. Keep yourself updated with latest developments in the industry. Name: Email: Note : We never rent, trade, or sell my email lists to anyone. We assure that your privacy is respected and protected. _______________________________________