在javadoc注释中使用HTML是好的还是坏的做法？
当我查看java方法的注释时,它们看起来都很好地使用顶部方法的名称,然后是整个方法头,但是当我将javadoc添加到我的方法时,它几乎不可读(我的意思是使用时弹出的信息)编写代码时的自动完成功能).
所以我尝试在javadoc评论中添加HTML.它看起来更好,但是当我生成javadoc并查看浏览器中的注释时,布局就搞砸了.
另外添加HTML使我在直接在代码中阅读时难以阅读.
我的意见的例子:
/**
* <br/>
* <li><b><i>hasChanged</i></b></li>
* <br/><br/><br/>
*
* <pre>public void hasChanged(boolean changed)</pre>
* <br/>
*
* This method can notify the observers when a change has occurred in a model.
* <br/><br/>
*
* The observer can then set the right controls
* <br/><br/>
*
* @param changed
* <br/><br/>
* Pass true if a model has been changed from it's starting values <br/><br/>
* Pass false if the model has it's initial values<br/><br/> …