Day6-18.Documentation example

文档示例

下再回到第一个Java程序，但是这次加上了文档注释：

//:object/HelloDate.java

import java.util.*;

/** The first Thinking in Java example program.

*Displays a string and today’s date.

*@author Bruce Eckel

*@author www.MindView.net

*@version 4.0

*/

public class HelloDate{

/** Entrv point to class & application

* @param args array of string arguments

* @throws exceptions No exceptions thrown

*/

public static void main (String [] args){

System.out.println(“Hello ,it’s: ”);

System.out.println(new Date());

}

}/* Output:(55% match)

Hello ,it’s:

Wed Oct 05 14:39:36 MDT 2005

*///:~

第一行采用我自己独特的方法，用一个“：” 作为特殊记号说明这是包含源文件名的注释行。

该行包含文件的路径信息（此时，object代表本章），随后是文件名。

最后一行也是一行注释，这个“///:~”标志源代码清单的结束。

自此，在通过编译器和执行检查后，文档就可以自动更新成本书的文本。

/*Output 标签标示将由这个文件生成输出的开始部分，通过这种形式，它会被自动的测试以验证其准确性。

在本例中，（55% match） 在向测试系统说明程序的每一次运行和下一次运行的输出存在着很大的差异，因此他们与这里列出的输出预期只有55%的相关性。

本书中能够产生输出的大部分示例都包含这种注释方式的输出，因此你可以查看他们的运行输出，并知晓其准确性。