Search |
|||
Sebastien Dionne's blogExtends javadoc with custom tags like @example.Posted by survivant on November 8, 2009 at 5:14 AM PST
I would like to show you how you could extend your javadoc to include samples directly into the javadoc without extra work.
What I don't like about javadoc is the lack of code sample. Something is can be hard to find the starting point of a new framework. Let's show a example, it will be easier to understand, and so simple.
In this example, we used a custom tag @example. The result will look like this.
There is a thing that you need to know to avoid surprises : Javadoc tool will cut the custom tag as soon as it detect another annotation, so don't forget to convert to HTML code like @ : become : "&"#64; To acheive that you need to add little config into your pom. Add the lines in bold.
»
Comments
Comments are listed in date ascending order (oldest first)
|
CategoriesArchivesRecent Entries |
||
|
|