作者:手机用户2602917233 | 来源:互联网 | 2024-10-11 15:11
Imtryingtodocumentanannotatedinterfaceandincludeasampleofhowitsusedinthejavadoc.
I'm trying to document an annotated interface and include a sample of how it's used in the javadoc. e.g.
我正在尝试记录一个带注释的界面,并在javadoc中包含一个如何使用它的示例。例如
/**
* Here's an example usage:
*
*
* @IFaceAnnotation(value="")
* public interface IFace {
*
* @MethodAnnotation("")
* public String Method();
* }
*
*/
However, Javadoc treats my annotations as javadoc instructions (like @param etc.) and as a result only prints:
但是,Javadoc将我的注释视为javadoc指令(如@param等),因此仅打印:
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:
*
*
* \@IFaceAnnotation(value="")
* public interface IFace {
*
* \@MethodAnnotation("")
* public String Method();
* }
*
*/
but this looks a bit messy.
但这看起来有点乱。
Just wondered if anyone had any suggestions, Thanks.
只是想知道是否有人有任何建议,谢谢。
3 个解决方案