JBuilder 2005中创建Javadoc文档
JBuilder 2005中创建Javadoc文档
http://soft.yesky.com/lesson/481/2028981.shtml
摘要：
JBuilder 2005中创建Javadoc文档
Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。
JBuilder提供了多项对Javadoc支持的功能，可以通过向导在工程窗格的树中创建Javadoc的节点，通过节点的菜单命名创建工程的Javadoc文档，可以通过诱导的方式录入Javadoc的标签，检验注释是否和源代码相匹配等。
本文，我们将讲解如何在源代码中用Javadoc标签写注释及如何创建Javadoc文档。
什么是Javadoc文档
虽然软件工程中把详细设计作为软件项目的一个重要的阶段，但在实践中往往没有得到落实。并不是这个阶段不重要，而是实施有很大的困难，因为软件需求是天生的易动症患者，好不容易详细设计出来后，需求已和当初的版本大相径庭，而花费巨大，精雕细琢的详细设计已变成昨日黄花了。
>>>>详细内容
Javadoc标签介绍
Javadoc注释由Javadoc标签和描述性文本组成，你可以为类、接口添加注释，也可为构造函数、值域、方法等类中的元素添加注释。
>>>>详细内容
编写Javadoc注释
可以通过代码模板快速的录入Javadoc注释，你也可以选择通过Javadoc对话框以一种形象化的方式录入 Javadoc注释。此外，JBuilder还提供了各种Javadoc的辅助功能，如JavadocInsight诱导录入，冲突报告和更正，特殊的 todo标签等。
>>>>详细内容
创建Javadoc文档
虽然在Java文件中编写注释后，马上可以切换到内容窗格的Doc视图页代码中对应的Javadoc文档，但在 Doc视图页中生成的文档仅是不完整的”范本”。首先，没有导航树，其次没有生成通过@see或@link关联内容的链接。所以你可以把Doc视图页中的 Javadoc文档看成是Javadoc最终版本的预览。
>>>>详细内容
总结
本文中我们介绍了Javadoc的标签，讲解了如何在JBuilder编辑Javadoc注释，你应该尽量使用 JavadocInsight、ClassInsight和ParameterInsight快速而正确地编写Javadoc注释。此外你应该将常用的注释做成模板，方便快速录入。
JBuilder提供的注释冲突报告和恢复的功能可以使你轻松解决注释冲突的问题，免除了单调的手工调整操作。
JBuilder还允许你自定义Javadoc标签，以满足一些个性化的要求。此外JBuilder自定义的todo标签可以使你随时随地在需要的地方作上标记，不至于遗漏未尽的工作。