gpt4 book ai didi

java - 在代码中处理/格式化 Javadoc 和注释的最佳方式是什么?

转载 作者:搜寻专家 更新时间:2023-10-31 19:49:21 24 4
gpt4 key购买 nike

<分区>

我浏览了这个论坛,我用谷歌搜索了这个,但我不确定处理同时出现在同一个类中的 Javadoc 和注释的最佳方法是什么。

从我从 Sun/Oracle 的文档中可以看出,他们似乎建议(虽然我真的找不到明确的声明)Javadoc 应该列在注释之上。

查看他们的示例 How and When to Deprecate API's .

这对于像@Deprecated 或@Override 这样简单的事情非常有用。但是如果您使用 JPA 和/或 Hibernate 呢?您的类和方法必然会被注释得更多(有时每个类或方法有两个或更多注释)。

我猜 Javadoc 仍在注解之上?

我还想知道如何最好地使用注释?我见过一些例子,其中注释“堆叠”在类、成员、方法之上。我还看到其他人在同一行列出注释(通常是这里的方法)。

哪个最好?哪个更具可读性?

您是否“记录”了您是否在 Javadoc 中注释了某些内容这一事实?

我正在寻找关于此的一组很好的文档和/或您自己关于什么是最可读/可维护的经验。

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com