chapter2.htm

一本Java由初级到高级的编程书籍

* &lt;pre&gt;<br>
* System.out.println(new Date());<br>
* &lt;/pre&gt;<br>
*/<br>
<br>
亦可象在其他Web文档里那样运用HTML，对普通文本进行格式化，使其更具条理、更加美观：<br>
<br>
/**<br>
* 您&lt;em&gt;甚至&lt;/em&gt;可以插入一个列表：<br>
* &lt;ol&gt;<br>
* &lt;li&gt; 项目一<br>
* &lt;li&gt; 项目二<br>
* &lt;li&gt; 项目三<br>
* &lt;/ol&gt;<br>
*/<br>
<br>
注意在文档注释中，位于一行最开头的星号会被javadoc丢弃。同时丢弃的还有前导空格。javadoc会对所有内容进行格式化，使其与标准的文档外观相符。不要将&lt;h1&gt;或&lt;hr&gt;这样的标题当作嵌入HTML使用，因为javadoc会插入自己的标题，我们给出的标题会与之冲撞。<br>
所有类型的注释文档——类、变量和方法——都支持嵌入HTML。<br>
<br>
2.8.4 @see：引用其他类<br>
所有三种类型的注释文档都可包含@see标记，它允许我们引用其他类里的文档。对于这个标记，javadoc会生成相应的HTML，将其直接链接到其他文档。格式如下：<br>
<br>
@see 类名<br>
@see 完整类名<br>
@see 完整类名#方法名<br>
<br>
每一格式都会在生成的文档里自动加入一个超链接的“See Also”（参见）条目。注意javadoc不会检查我们指定的超链接，不会验证它们是否有效。<br>
<br>
2.8.5 类文档标记<br>
随同嵌入HTML和@see引用，类文档还可以包括用于版本信息以及作者姓名的标记。类文档亦可用于“接口”目的（本书后面会详细解释）。<br>
<br>
1. @version<br>
格式如下：<br>
@version 版本信息<br>
其中，“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记，就会从生成的HTML文档里提取出版本信息。<br>
<br>
2. @author<br>
格式如下：<br>
@author 作者信息<br>
其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记，就会专门从生成的HTML文档里提取出作者信息。<br>
可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。<br>
<br>
2.8.6 变量文档标记<br>
变量文档只能包括嵌入的HTML以及@see引用。<br>
<br>
2.8.7 方法文档标记<br>
除嵌入HTML和@see引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。<br>
<br>
1. @param<br>
格式如下：<br>
@param 参数名 说明<br>
其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。<br>
<br>
2. @return<br>
格式如下：<br>
@return 说明<br>
其中，“说明”是指返回值的含义。它可延续到后面的行内。<br>
<br>
3. @exception<br>
有关“违例”（Exception）的详细情况，我们会在第9章讲述。简言之，它们是一些特殊的对象，若某个方法失败，就可将它们“扔出”对象。调用一个方法时，尽管只有一个违例对象出现，但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以，违例标记的格式如下：<br>
@exception 完整类名 说明<br>
其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”（同样可以延续到下面的行）告诉我们为什么这种特殊类型的违例会在方法调用中出现。<br>
<br>
4. @deprecated<br>
这是Java 1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。<br>
<br>
2.8.8 文档示例<br>
下面还是我们的第一个Java程序，只不过已加入了完整的文档注释：<br>
<br>
92页程序<br>
<br>
第一行：<br>
//: Property.java<br>
采用了我自己的方法：将一个“:”作为特殊的记号，指出这是包含了源文件名字的一个注释行。最后一行也用这样的一条注释结尾，它标志着源代码清单的结束。这样一来，可将代码从本书的正文中方便地提取出来，并用一个编译器检查。这方面的细节在第17章讲述。<br>
<br>
2.9 编码样式<br>
一个非正式的Java编程标准是大写一个类名的首字母。若类名由几个单词构成，那么把它们紧靠到一起（也就是说，不要用下划线来分隔名字）。此外，每个嵌入单词的首字母都采用大写形式。例如：<br>
class AllTheColorsOfTheRainbow { // ...}<br>
对于其他几乎所有内容：方法、字段（成员变量）以及对象句柄名称，可接受的样式与类样式差不多，只是标识符的第一个字母采用小写。例如：<br>
<br>
class AllTheColorsOfTheRainbow {<br>
int anIntegerRepresentingColors;<br>
void changeTheHueOfTheColor(int newHue) {<br>
// ...<br>
}<br>
// ...<br>
}<br>
<br>
当然，要注意用户也必须键入所有这些长名字，而且不能输错。<br>
<br>
2.10 总结<br>
通过本章的学习，大家已接触了足够多的Java编程知识，已知道如何自行编写一个简单的程序。此外，对语言的总体情况以及一些基本思想也有了一定程度的认识。然而，本章所有例子的模式都是单线形式的“这样做，再那样做，然后再做另一些事情”。如果想让程序作出一项选择，又该如何设计呢？例如，“假如这样做的结果是红色，就那样做；如果不是，就做另一些事情”。对于这种基本的编程方法，下一章会详细说明在Java里是如何实现的。<br>
<br>
2.11 练习<br>
(1) 参照本章的第一个例子，创建一个“Hello，World”程序，在屏幕上简单地显示这句话。注意在自己的类里只需一个方法（“main”方法会在程序启动时执行）。记住要把它设为static形式，并置入自变量列表——即使根本不会用到这个列表。用javac编译这个程序，再用java运行它。<br>
(2) 写一个程序，打印出从命令行获取的三个自变量。<br>
(3) 找出Property.java第二个版本的代码，这是一个简单的注释文档示例。请对文件执行javadoc，并在自己的Web浏览器里观看结果。<br>
(4) 以练习(1)的程序为基础，向其中加入注释文档。利用javadoc，将这个注释文档提取为一个HTML文件，并用Web浏览器观看。<br>
</p>

<!--msthemeseparator--><p align="center"><img src="../_themes/inmotion/inmhorsa.gif" tppabs="http://member.netease.com/%7etransbot/Thinking%20in%20Java/_themes/inmotion/inmhorsa.gif" width="300" height="10"></p>

<p align="center"><a href="../../../../tppmsgs/msgs0.htm#1" tppabs="http://www.bruceeckel.com/">英文版主页</a> | <a href="../index.htm" tppabs="http://member.netease.com/%7etransbot/Thinking%20in%20Java/index.htm">中文版主页</a> | <a href="../contents/index.htm" tppabs="http://member.netease.com/%7etransbot/Thinking%20in%20Java/contents/index.htm">详细目录</a> 
| <a href="../about/index.htm" tppabs="http://member.netease.com/%7etransbot/Thinking%20in%20Java/about/index.htm">关于译者</a></p>
</body>
</html>