Chr*_*ich 5 java formatting annotations javadoc code-documentation
我已经浏览了这个论坛,我用Google搜索了这个,我不确定处理同一类中出现的Javadoc和注释的最佳方法是什么.
从我从Sun/Oracle的文档中可以看到,他们似乎建议(尽管我真的找不到一个明确的陈述)Javadoc应该在注释的顶部列出.
请参阅他们的示例如何以及何时弃用API.
这对于像@Deprecated或@Override这样简单的东西非常有用.但是,如果你使用JPA和/或Hibernate呢？您的类和方法必须更加注释(有时每个类或方法有两个或更多注释).
我猜Javadoc仍然在注释之上？
另外我想知道如何最好地使用注释？我已经看到了一些示例,其中注释"堆栈"在类,成员,方法之上.我已经看到其他人在同一行列出注释(通常是这里的方法).
哪个最好？哪个更具可读性？
你是否"记录"了你在Javadoc中注释某些内容的事实？
我正在寻找一套关于这方面的好文档和/或你自己对最易读/可维护的经验.
Javadoc只是您记录类,方法等的地方.注释可以改变给定代码的功能(例如来自Hibernate或Spring的注释).因此,对我来说,很明显注释应该更接近代码(因此,在javadoc和方法/函数之间).
但是如何编写注释,哪里有很多呢？这取决于,我更喜欢将它们分开排列,除非有短路且以某种方式连接,否则几乎没有例外.
在Javadoc中明确记录您正在使用注释我认为不是一个好主意.@Documented注释本身可以有注释,表明它们应该出现在生成的javadoc中.除此之外,它是实现细节--javadoc应该告诉你是做什么方法/对象,而不是你是如何做到的(至少,大多数情况下).
| 归档时间： |
|
| 查看次数： |
1617 次 |
| 最近记录： |