荔园在线

荔园之美,在春之萌芽,在夏之绽放,在秋之收获,在冬之沉淀

[回到开始] [上一篇][下一篇]


发信人: Peter (小飞侠), 信区: Program
标  题: Java语言中的注释
发信站: BBS 荔园晨风站 (Wed Jan 27 17:46:15 1999), 转信


  程序中合理的注释可以增加程序的可读性,便于程序员理解程序。
本文讨论的是Java语言的注释方法。
    Java语言有三种有效的注释方法:
    ∥注释内容
    /*注释内容*/
    /**注释内容*/
    Java语言的程序员可以通过这三种方法对程序进行注释。了解C+
+语言的程序员不难发现,上述三种注释方法中,前两种和C++语言中的
注释方法一样,而第三种是Java语言独特的注释方法。其中第一种注
释方法由∥开始以Enter结束,即当编译器遇到∥时将忽略本行中∥后
面的内容。第二种注释方法是以/*开始以*/结束,编译器将忽略/*和*
/之间的所有内容,这种注释方法和第一种注释方法不同之处在于其注
释内容可以为多行。
    这里要重点讨论的是第三种方法,这种注释方法是Java特有的。
注释开头/**中附加的* 用于调用javadoc程序,这种程序用于提取用
这种格式写成的所有注释,并创建一个外部文档。javadoc处理器可以
将这些注释提取到HTML文档,所以这种注释(有时也成为doc注释)可能
包含用于代码使用举例的HTML markup标识,但不应该包括HTML结构标
识,如<HR>或<H1>。此外,有一组特殊的标识用于doc注释,为文档提供
了一种附加的格式。所有这些标识都由@开始。这些唯一的javadoc标
识必须放在doc注释行的最前头,如果使用一个以上的同类标识,它们
必须放在后续行中。下面是一些特殊的doc注释标识:
    ·@author text在指定的文本前显示"Author:"输入项,该标识只
能用于一个类定义的前面。
    ·@exception full-classname description该标识为文档提供
一个"Throws:"输入项, 包括特殊的指定类名及其描述。这一标识只
能用于方法定义之前。
    ·@param parameter-name description这一标识将特定的参数
及其描述加到现行方法的"Parameter:"段中。允许续行。该标识只能
用于一个方法定义之前。
    ·@return description该标识在包含特定描述的文档中加入一
个"Return:"段。它只能用于方法定义之前。
    ·@see classname在类、变量或方法之前使用这种标识可以将"S
ee Also:"输入项加到文档中。这种输入项的增加为特定的类提供了
一种超级链接(Hyperlink)。
    ·@see full-classname功能同上。
    ·@see full-classname#method-name功能同上。
    ·@version text这种标识很方便地将包含特殊文本的"Version:
"输入项增加到文档中。该标识只能用于类定义之前。

--

--
※ 来源:.BBS 荔园晨风站 bbs.szu.edu.cn.[FROM: 192.168.1.3]


[回到开始] [上一篇][下一篇]

荔园在线首页 友情链接:深圳大学 深大招生 荔园晨风BBS S-Term软件 网络书店