Question

生成项目帮助文档chm时，有个javabean，需要为每个字段写javadoc标签吗？

有个javabean类，定义了很多字段，现在要生成chm，想要对每个字段都做一段解释，需要在每个字段前面都写上/** ... */ 吗？有没有方便的方法？

Answer 1

其实,你可以设想一下.
我们的生成的帮助文档中对于这些属性会有什么标识.
属性名
属性名的解释

你可以理解为这是一种map的关系.
那么,你在制作文档时,需要告诉文档的制作者这些map的信息.
最简单的,也是最实用的方法,就是在每个属性上面都写一个注释.这样,文档的制作者,会扫描到属性,以及属性对应的解释.来生成api文档.你想一下,还能有更简单的方法了么?如果你能想到更简单的方法.那么,只有两种可能,一种是你没有找到更好的制作api的工具,另一种是,你的方法有着某种局限性.
很多类似的问题都可以用这种方式来分析.自己去想,有没有更好的实现方式.然后为什么

Answer 2

嗯 没有方便的方法 这只是形成javadoc帮助文档 生成网页版 然后在用命令和工具生成chm文档

Answer 3

貌似木有。