Menu
Something like:
/** * See {@linktourl http://google.com} */ 
880
@see <a href="URL#value">label</a> : Adds a link as defined by URL#value . The URL#value is a relative or absolute URL. The Javadoc tool distinguishes this from other cases by looking for a less-than symbol ( < ) as the first character.
There are no real restrictions on the use of HTML in Javadoc comments. The Javadoc documentation states: Comments are written in HTML - The text must be written in HTML, in that they should use HTML entities and can use HTML tags.
It is shorthand that tells the java docs to insert a link to the desired place when they are being viewed. For instance when you view the javadocs for whatever method has that inside your IDE you'll be shown a link that will take you to the KeyEvent.
This creates a "See Also" heading containing the link, i.e.:
/** * @see <a href="http://google.com">http://google.com</a> */ will render as:
See Also:
http://google.com
whereas this:
/** * See <a href="http://google.com">http://google.com</a> */ will create an in-line link:
See http://google.com
149
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
