Force javadoc to ignore an annotation

Question

I'm trying to document an annotated interface and include a sample of how it's used in the javadoc. e.g.

/** * Here's an example usage: * * <PRE> * @IFaceAnnotation(value="") * public interface IFace { * * @MethodAnnotation("") * public String Method(); * } * </PRE> */

However, Javadoc treats my annotations as javadoc instructions (like @param etc.) and as a result only prints:

Here's an example usage:

In the generated documentation. The only way i've been able to stop this is by adding an extra char before the annotation e.g.

/** * Here's an example usage: * * <PRE> * \@IFaceAnnotation(value="") * public interface IFace { * * \@MethodAnnotation("") * public String Method(); * } * </PRE> */

but this looks a bit messy.

Just wondered if anyone had any suggestions, Thanks.

Mork0075 · Accepted Answer · 2009-04-03 10:59:24Z

2

You can use '@' instead of the @, but thats even more ugly.

answered Apr 3, 2009 at 10:59

Mork0075

5,9104 gold badges27 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

A248 · Accepted Answer · 2020-06-19 22:51:02Z

You could also use {@literal @}. No nasty escape characters.

/** * Here's an example usage: * * <PRE> * {@literal @}IFaceAnnotation(value="") * public interface IFace { * * {@literal @}MethodAnnotation("") * public String Method(); * } * </PRE> */

cflewis · Accepted Answer · 2009-08-16 08:26:14Z

0

Have you tried wrapping it in the {@code} notation?

answered Aug 16, 2009 at 8:26

cflewis

7,4318 gold badges31 silver badges37 bronze badges

1 Comment

Lonzak Over a year ago

That alone doesn't help!

Lonzak · Accepted Answer · 2017-10-16 19:04:05Z

For the record, the correct and complete answer is:

/** * Here's an example usage: * * <pre> * {@code} * &#064;IFaceAnnotation(value="") * public interface IFace { * * &#064;MethodAnnotation("") * public String Method(); * } * </pre> */

which results in

Collectives™ on Stack Overflow

Force javadoc to ignore an annotation

4 Answers 4

Comments

Comments

1 Comment

Comments

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

1 Comment

Comments

Related