JBuilder2005成立开辟文档之编写注释[Java编程]

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. }

　　以上是“JBuilder2005成立开辟文档之编写注释[Java编程]”的内容，如果你对以上该文章内容感兴趣，你可以看看七道奇为您推荐以下文章：