繁体   English   中英

在package-info.java中使用JavaDoc的导入

[英]Consuming imports for JavaDoc in package-info.java

在我正在记录的软件包的JavaDoc中(具体来说,在package-info.java文件中),我有许多看起来像{@link some.really.long.module.ClassName} ,我自然而然地我想只是导入ClassName并改为说{@link ClassName} ,但我尝试过没有尝试过。 这甚至可能吗?

我已经尝试将导入放在包声明和JavaDoc之上,但是这显示了语法错误。 我已经尝试将导入放在包声明和JavaDoc下面,但是然后JavaDoc进程警告Tag @link: reference not found: ClassName

只需在package-info文档中使用完全限定名称即可。 JavaDoc将生成HTML而不显示完全限定名称(至少在1.7中),因此结果应该看起来很好。 打字会更烦人。

你可以做:

This class {@linkplain some.really.long.module.ClassName ClassName} does bla bla bla...

这将显示为

这个类ClassName做bla bla bla ...

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM