Java中如何在其他类的文档注释中引用目标类的私有字段
解决方案
原写法失效的核心原因是
attribute是类A的私有成员,标准Javadoc的{@link}标签默认不支持链接私有成员,仅在生成Javadoc时开启私有成员导出参数才会生效。你不需要生成正式Javadoc、仅作为内部开发参考的话,可以选择以下任意一种方案:
- 方案1:最简洁的纯文本标记(所有人都能直接看懂,无任何兼容性问题)
直接在注释里用反引号标记字段名即可,不需要依赖{@link}能力:
public class B { /** * 该方法会将传入的A类实例的私有字段 `A.attribute` 设为false。 */ public void turnOffField (A a) { //... } }
方案2:保留
{@link}仅用于IDE跳转(适合仅在IDE内查看注释的场景)
不需要修改原有写法,虽然正式生成Javadoc时会报找不到成员的警告,但IntelliJ IDEA、Eclipse等主流开发IDE都可以识别私有字段的{@link}引用,按住Ctrl点击即可直接跳转到类A的对应字段,完全满足内部开发查看的需求。方案3:兼容正式Javadoc规范的写法
如果要避免Javadoc警告,也可以链接公有的setter方法,同时补充说明修改的是对应私有字段:
public class B { /** * 该方法会修改{@link A#setAttribute(Boolean)}对应的私有字段`attribute`,将其值设为false。 */ public void turnOffField (A a) { //... } }
内容的提问来源于stack exchange,提问作者ankaAJ
相关产品推荐
相关产品推荐

