In this article I’ll show you a simple technique for inserting XML code snippets in your Javadocs that keeps them readable in both the source code and the resulting HTML files.
Problems with adding comments
Inserting code snippets into Javadoc comments that read well in both the source code and the HTML files produced by Javadoc can [...]