仓酷云

标题: JAVA教程之JBuilder2005创立开辟文档之编写正文 [打印本页]

作者: 山那边是海 时间: 2015-1-18 11:09
标题: JAVA教程之JBuilder2005创立开辟文档之编写正文
最初被命名为Oak，目标设定在家用电器等小型系统的编程语言，来解决诸如电视机、电话、闹钟、烤面包机等家用电器的控制和通讯问题。创立　　能够经由过程代码模板疾速的录进Javadoc正文，你也能够选择经由过程Javadoc对话框以一种抽象化的体例录进Javadoc正文。别的，JBuilder还供应了各类Javadoc的帮助功效，如JavadocInsight引诱录进，抵触呈报和改正，特别的todo标签等。

　　1、Javadoc对话框

　　在编纂器中，将光标放在类、办法、值域等元素界说处右击，在弹出的菜单当选择Add->JavadocforXXX将修改Javadoc对话框。
翻开Person.java文件，将光标移到机关函数中，按照上述操纵步骤修改Javadoc对话框，以下图所示：

Javadoc对话框
　　在Description中列出了机关函数的形貌信息，而Tags中列出机关函数一切Javadoc正文标签。你能够经由过程对话框右下角的按钮新增、编纂、删除标签，也能够调剂它们的地位。

　　上面，我们为机关函数增加一个新的@see标签，链接到Car.drive(intdirection,intspeed)函数中。

　　1．点击JavadocforConstructor"Person"对话框的Add...按钮，弹出AddJavadocTag对话框，如0所示。

　　2．从Tag下拉框当选择see选项。

　　3．在Description中录进javadoc.tool.Car#drive(int,int)。

　　4．按OK前往JavadocforConstructor"Person"对话框，再按OK在编纂器中天生这个新的标签。

0AddJavadocTag对话框
　　实战履历：

　　固然利用Javadoc对话框能够以一种抽象的体例创立Javadoc正文，削减抵触几率，但因为必要在多个弹出的对话框中操纵，且必要利用到键盘和鼠标，以是在键进速率和操纵联贯性都很差。笔者在开辟过程当中几近从未利用这类粗笨的办法，既然是己所不欲，固然也不但愿读者伴侣利用。但初学者却能够经由过程Javadoc对话框增强对Javadoc标签的了解。

　　2、利用JavadocInsight

　　象MemberInsight、ParameterInsight等一样，JavadocInsight以引诱的体例帮助你疾速录进准确的Javadoc标签。

　　因为Javadoc标签都带有@字符，当你录进@字符后JavadocInsight引诱窗口主动弹出，延不时间能够经由过程Tools->Perferences...->Editor->CodeInsight设置页中调剂，默许为250ms。一个典范的JavadocInsight窗口以下图所示：

1JavadocInsight
　　在正文块中除能够用JavadocInsight引诱窗口外，能够经由过程Ctrl+Space利用MemberInsight引诱窗口录进类值域或办法，经由过程Ctrl+Alt+Space利用ClassInsight录进类名。JavadocInsight、MemberInsight和ClassInsight有如三剑客，包管疾速和准确地录进Javadoc正文段。

　　提醒：

　　JavadocInsight窗口中除todo外都显现为粗体款式，todo标签不是Javadoc尺度的标签，而是JBuilder自界说的标签。JBuilder同意界说自界说的Javadoc标签，一切自界说的Javadoc标签显现为非粗体款式。关于自界说Javadoc标签及todo标签的具体内容，拜见本文后续的内容。　　3、自界说的Javadoc标签

　　JBuilder同意你为了完成特别的用处自界说扩大的Javadoc标签。在这大节里，我们来界说一个名为notice的自界说标签。

　　1．Project->ProjectProperties...->Build->Javadoc，在Javadoc设置页中列出了一切自界说的Javadoc标签。因为todo标签是JBuilder自己自界说标签，以是todo呈现在列表中，以下图所示：

2Javadoc自界说标签设置页
　　2．按New...按钮，弹出CreateCustomTag对话框，以下图所示：

3创立自界说Javadoc标签对话框
　　・Tagname：notice，标署名

　　・HeadingText：呈现在Javadoc文档中的题目。

　　・Placementoptions：选择一切的选项，暗示这个标签能够对代码中的任何范例元素举行正文。

　　3．按OK创立这个notice自界说标签。

　　翻开Person.java用notice标签为sex值域写Javadoc正文：

　　1)/**@notice这是用于暗示性其余变量，正当值只能为MALE和FEMALE*/
　　2)protectedintsex;

　　对应的Javadoc文档以下图所示的文档：

4自界说Javadoc标签天生的文档
　　个中"注重"为CreateCustomTag对话框中的Headingtext的内容，在上图中我们专程标识出来。

　　4、利用代码模板

　　在第4章中我们已经先容过代码模板，你一样能够为经常使用的正文块创立一个Javadoc模板，"多快好省"地录进Javadoc正文。
依照习气体例，每一个类都必要一个类正文，类正文都是类似的，上面我们就来创立一个类正文代码模板，这个代码模板以下所示：

　　代码清单2类正文代码模板

1./**
2.*<pre>|</pre>
3.*@see
4.*@version$Version,2005-04-|
5.*@author$Author
6.*@sinceJDK1.3
7.*/
　　1)Tools->Perferences...->Editor->Templates->Common，点击Common设置页的Add...按钮，弹出NewCodeTemplate对话框，以下图所示：

5创立新代码模板对话框
　　・Templatename：clscmt模板的名字

　　・Description：class’scomment模板形貌信息

　　2)在Code中录进代码清单2的代码，个中带$前缀的标识是一个宏操纵符，在调剂模板录进正文块后，宏将被交换成详细的值，你能够经由过程Macro...按钮，在InsertMacro对话框当选择一个宏，以下图所示：

6拔出宏对话框
　　3)录进代码模板后，按OK前往Common设置页，再按OK后完成创立clscmt代码模板。

　　创立完clscmt模板后，你就能够在编纂器顶用Ctrl+J挪用这个模板了，以下图所示：

7挪用clscmt代码模板
　　录进clscmt代码模板后，将发生一个类正文块，原$Author和$Version宏已被交换成Project->ProjectProperties...->General设置页的classJavadocfields列表中所设置的值了，以下图所示：

8用代码模板录进Javadoc正文块
　　此时，General设置页的classJavadocfields列表的设置情形以下图所示：

9Javadoc域设置　　5、Javadoc正文抵触

　　Javadoc正文是对源码程序的申明，以是正文必需和源程序坚持分歧。假定一个办法共有两个进参，但对应的Javadoc仅对个中一个进参用@param举行了申明，二者呈现了纷歧致，这时候就呈现了正文抵触。JBuilder可以反省出这类纷歧致的抵触，布局窗格树中将呈现一个JavadocConflicts的文件夹，呈报以后Java文件中一切的正文抵触，以下图所示：

0Javadoc抵触呈报
　　每条抵触正文不仅给出了抵触缘故原由的扼要形貌，还指定了抵触产生的地位。你能够点击某抵触项，在弹出的对话框当选择FixJavadocConflictfor"XXX"修复这个抵触。你也能够右击JavadocConflicts文件夹，在弹出的菜单当选择FixJavadocConflicts修复全体的抵触。

　　注重：

　　Javadoc抵触只要在Errors文件夹中一切的语法毛病都已失掉办理后才会呈报出来。

　　6、todo标签

　　todo是JBuilder自界说的标签，但它其实不用于天生Javadoc文档的内容。它相称于一个"助记符"，暗示此处有一个未完成的事情或一个待改善的事情，便利往后检索和处置这些未尽之事。

　　以后程叙文件中的一切todo标签回结在布局窗格的ToDo文件夹下。假定我们在Person.java中增加两个todo标签，以下所示：

1.…
2.publicclassPersonimplementsSerializable
3.{
4.　publicPerson(Stringname,intsex)throwsPersonArgumentException
5.　{
6.　　if(sex!=MALE&&sex!=FEMALE)
7.　　　thrownewPersonArgumentException("参数不准确");
8.　　　/**@todo还需做更多的校验*/
9.　　　this.name=name;
10.　　　this.sex=sex;
11.　}
12.　…
13.　/**
14.　*设置性别
15.　*@paramsexint
16.　*/
17.　publicvoidsetSex(intsex)
18.　{
19.　　/**@todo必要对进参做判别*/
20.　　this.sex=sex;
21.　}
22.}
　　在第8、19行增加上两个todo标签。todo标签能够放在程序的任何中央，而不象Javadoc标签一样必需安排在类、接口、办法等界说语句的后面。此时，这两个todo标签都将呈现在布局窗格的ToDo文件夹下，以下图所示：

1ToDo文件夹
　　点击ToDo文件夹下的项目，编纂器定位到代码中响应的地位。

　　假如你在工程的很多中央都拔出了todo标签，怎样检察检索检察它们呢？经由过程Search->ViewTodos，信息窗格中将列收工程中一切的todo标志，以下图所示：

2工程或工程组中一切todo标志
　　不仅包括了todo的正文信息，了局列表中还列出了标志地点的程叙文件及目次。你能够在Commentcontains中输出关头字对todo标志的正文举行查询过滤。

　　提醒：

　　一个工程性的软件项目，常常因为项目进度的紧急，囿于工夫和人力资本，你大概不能不舍弃一些好的办理办法而用一些易于完成的办法应急。你但愿未来在同意的前提下再"重拾旧江山"，常言道，好忘性不如烂笔头，假如在响应的中央用todo标签象武陵人从桃花源前往一样"到处志之"，就不会"遂迷不复得"了。
因为能用到多少功能就用多少，不能用就不用！总的来说：要简单要性能好，可以不用框架。你说java复杂，就是因为你把java（j2ee）与这些框架混在了一起。

作者: 第二个灵魂 时间: 2015-1-20 15:24
《JAVA语言程序设计》或《JAVA从入门到精通》这两本书开始学，等你编程有感觉的时候也可以回看一下。《JAVA读书笔记》这本书，因为讲的代码很多，也很容易看懂，涉及到面也到位。是你学习技术巩固的好书，学完后就看看《JAVA编程思想》这本书，找找一个自己写的代码跟书上的代码有什么不一样。

作者: 飘飘悠悠 时间: 2015-1-29 12:13
J2SE开发桌面应用软件比起 VC,VB,DEPHI这些传统开发语言来说，优势好象并不明显。J2ME对于初学者来说，好象又有点深奥，而且一般开发者很难有开发环境。

作者: 蒙在股里 时间: 2015-2-6 00:39
关于设计模式的资料，还是向大家推荐banq的网站 [url]http://www.jdon.com/[/url]，他把GOF的23种模式以通俗易懂的方式诠释出来，纯Java描述，真是经典中的经典。

作者: 深爱那片海 时间: 2015-2-9 03:29
所以现在应用最广泛又最好学的就是J2EE了。 J2EE又包括许多组件，如Jsp,Servlet,JavaBean,EJB,JDBC,JavaMail等。要学习起来可不是一两天的事。那么又该如何学习J2EE呢？当然Java语法得先看一看的，I/O包，Util包，Lang包你都熟悉了吗？然后再从JSP学起。

作者: 小魔女 时间: 2015-2-13 11:35
如果要向java web方向发展也要吧看看《Java web从入门到精通》学完再到《Struts2.0入门到精通》这样你差不多就把代码给学完了。有兴趣可以看一些设计模块和框架的包等等。

作者: 飘灵儿 时间: 2015-3-3 20:08
你可以去承接一些项目做了，一开始可能有些困难，可是你有技术积累，又考虑周全，接下项目来可以迅速作完，相信大家以后都会来找你的，所以Money就哗啦啦的。。。。。。

作者: 只想知道 时间: 2015-3-11 13:01
Sun公司看见Oak在互联网上应用的前景，于是改造了Oak，于1995年5月以Java的名称正式发布。Java伴随着互联网的迅猛发展而发展，逐渐成为重要的网络编程语言。

作者: 因胸联盟 时间: 2015-3-25 20:14
自从Sun推出Java以来，就力图使之无所不包，所以Java发展到现在，按应用来分主要分为三大块：J2SE,J2ME和J2EE,这也就是Sun ONE(Open Net Environment)体系。J2SE就是Java2的标准版，主要用于桌面应用软件的编程；J2ME主要应用于嵌入是系统开发，如手机和PDA的编程；J2EE是Java2的企业版，主要用于分布式的网络程序的开发，如电子商务网站和ERP系统。

欢迎光临仓酷云 (http://ckuyun.com/)