5、Javadoc注释冲突
Javadoc注释是对源码程序的说明，所以注释必须和源程序保持一致。假设一个方法共有两个入参，但对应的Javadoc仅对其中一个入参用@param进行了说明，两者出现了不一致，这时就出现了注释冲突。JBuilder能够检查出这种不一致的冲突，结构窗格树中将出现一个Javadoc Conflicts的文件夹，报告当前Java文件中所有的注释冲突，如下图所示：
 图 20 Javadoc冲突报告 |
每条冲突注释不但给出了冲突原因的简要描述，还指定了冲突发生的位置。你可以点击某冲突项，在弹出的对话框中选择Fix Javadoc Conflict for "XXX"修复这个冲突。你也可以右击Javadoc Conflicts文件夹，在弹出的菜单中选择Fix Javadoc Conflicts修复全部的冲突。
注意：
Javadoc冲突只有在Errors文件夹中所有的语法错误都已经得到解决后才会报告出来。
6、todo标签
todo是JBuilder自定义的标签，但它并不用于生成Javadoc文档的内容。它相当于一个"助记符"，表示此处有一个未完成的工作或一个待改进的工作，方便日后检索和处理这些未尽之事。
当前程序文件中的所有todo标签归结在结构窗格的To Do文件夹下。假设我们在Person.java中添加两个todo标签，如下所示：
1. …
2. public class Person implements Serializable
3. {
4. public Person(String name ,int sex) throws PersonArgumentException
5. {
6. if(sex != MALE && sex != FEMALE)
7. throw new PersonArgumentException("参数不正确");
8. /** @todo 还需做更多的校验 */
9. this.name = name;
10. this.sex = sex;
11. }
12. …
13. /**
14. * 设置性别
15. * @param sex int
16. */
17. public void setSex(int sex)
18. {
19. /** @todo 需要对入参做判断 */
20. this.sex = sex;
21. }
22. } |
在第8、19行添加上两个todo标签。todo标签可以放在程序的任何地方，而不象Javadoc标签一样必须放置在类、接口、方法等定义语句的前面。此时，这两个todo标签都将出现在结构窗格的To Do文件夹下，如下图所示：
 图 21 To Do文件夹 |
点击To Do文件夹下的项目，编辑器定位到代码中相应的位置。
如果你在工程的许多地方都插入了todo标签，如何查看检索查看它们呢？通过Search->View Todos，信息窗格中将列出工程中所有的todo标记，如下图所示：
 图 22 工程或工程组中所有todo标记 |
不但包含了todo的注释信息，结果列表中还列出了标记所在的程序文件及目录。你可以在Comment contains中输入关键字对todo标记的注释进行查询过滤。
提示：
一个工程性的软件项目，往往由于项目进度的紧迫，囿于时间和人力资源，你可能不得不舍弃一些好的解决方法而用一些易于实现的方法应急。你希望将来在允许的条件下再"重拾旧山河"，常言道，好记性不如烂笔头，如果在相应的地方用todo标签象武陵人从桃花源返回一样"处处志之"，就不会"遂迷不复得"了。 |
