给下面的java程序注释

给下面的java程序注释,第1张

首先,你的代码有两处错,main函数定义需要 static关键字,

第二是定义数组容量,只需要在new对象的时候设置容量大小,

在你的代码中,目标是取平均值,这里其实不需要定义数组,显得多此一举,您可以自行去掉,下面是你的代码的注释,请采纳!

import javautilScanner;

public class Test {

    

    // public void main(String[] args) {

    // double[5] cj = new double[5];

    //创建主函数

    public static void main(String[] args) {

        //定义double数组,容量5

        double[] cj = new double[5];

        //定义扫描键盘输入

        Scanner sc = new Scanner(Systemin);

        int i;

        //平均数变量

        double avg = 00d;

                //for循环,变量i从0开始没循环一次i+1,当不满足条件i<5时跳出循环

        for (i = 0; i < 5; i++){

            Systemoutprintln("请输入第" + (i + 1) + "个数");

            //键盘输入小数并赋值到double数组中

            cj[i] = scnextDouble();

            //将所有输入的数值相加

            avg = avg + cj[i];

        }

        //取平均数

        avg = avg / 5;

        Systemoutprintln("平均分为:" + avg);

    }

}

对于软件工程来说代码的编写并不是重要的事情。文档编写的重要性不亚于程序代码本身。如果代码与文档是分离的,那么在每次修改代码时,都需要修改相应的文档就会是一件相当麻烦的事情。所以我们通过javadoc将代码同文档“连接”起来。

Javadoc是什么?

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。

Javadoc输出的是一些HTML文件,我们可以通过WEB浏览器来查看它。

Javadoc的语法:

所有Javadoc都只能源于/开始和/结束。使用javadoc有二种方式,一种是嵌入HTML另一种是使用文档标签。所谓文档标签就是一些以 “@”开头的命令,且“@”要置于注释行的最前面。而“行内文档标签”则可以出现在Javadoc注释中的任何地方,它们也是以“@”字符开头,但要括在共括号内。

Javadoc只能为public或者protected成员进行文档注释。private和包内访问的成员的注释会被忽略掉。这样做是有道理的,因为只有public和protected成员才能在文件之外被使用,这也体现了封装性的优点。

嵌入HTML:

Javadoc将HTML代码嵌入到所生成的HTML文件中。这样能充分利用HTML的功能。比如:

/

this is my test program;

/

但一般我们不要在HTML里使用标题,如

,因为Javadoc会插入自己的标题,我们的标题可能会干扰它。

一些有用的标签:

1)@see:引用其它类的文档,相当于超链接,Javadoc会在其生成的HTML文件中,将@see标签链到其他的文档

@see classname

这样在生成的文档中会出现"See Also"的超链蛸。但是Javadoc不去检查你的超链接是否有效。

2){@link packageclass#member label}

与@See的功能一样,只是用label作主超链接,而不是用"see also"

3){@docRoot}:标签产生 到文档根目录的相对路径,用于文档树页面的显式超链接

4){@inheritDoc}:标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中。

5)@version:使用方法为@version 2212

2212是我们作的版本说明信息

6)@author:使用方法为 @author PowerFedora powpro@hotmailcom

也就是说我们可以在@author后加上作者名字,email等****

7)@since:这个标签允许你指定程序最早使用的版本。比如我们看JDK Document里的每个类最后都会说明从JDK哪个版本开始启用。

8)@param:@param name 用于输入客户的姓名

@param后面是方法的参数,以及相应的说明

我们可以使用任意数量的此标签,每个参数都可以有这样一个标签

9)@return this is description

@return后面是描述返回值的含义,可以延续几行。

10)@throws fully-qualified-class-name description

fully-qualified-class-name为异常类的完整名字,而description告诉你为什么此异常会在方法中调用出现。

11)@deprecated:用于指出一些旧特性已由改进的新特性所取代,建议用户不要再使用旧特性。

接下来我们用一个代码将上述所有的标签都使用起来,看一下效果:

//: test Javadoc,JavaCodejava

import javautil;

/ 这是一个为了测试Javadoc而专门写的类

功能是打印字符串

@author PowerFedora

@author powpro@hotmailcom

@version 10

/

public class JavaCode {

/ 这里的main函数,作为java程序的入口

@param 参数为一个String对象数组

@return 没有返回值的内容

@exception exceptions 没有异常被抛出

/

public static void main(String[] args){

String a = "中华人民共和国";

Systemoutprint(a);

}

} ///:~值得一题的是,如果你使用eclipse的话,完全不需要背这些标签。当我们在需要注释的地方打上/之后,再打@符号eclipse会自动显示所支持的标签供我们选择。

同样在生成HTML文档时我们也可以利用eclipse的export功能直接导出,否则用javadoc手工来生成的话是件相当痛苦的事情。

以下列出来javadoc支持的参数:

-author

-bootclasspath

-bottom

-breakiterator

-charset

-classpath

-d

-docencoding

-docfilessubdirs

-doclet

-docletpath

-doctitle

-encoding

-exclude

-excludedocfilessubdir

-extdirs

-footer

-group

-header

-help

-helpfile

-J

-keywords

-link

-linkoffline

-linksource

-locale

-nocomment

-nodeprecated

-nodeprecatedlist

-nohelp

-noindex

-nonavbar

-noqualifier

-nosince

-notimestamp

-notree

-overview

-package

-private

-protected

-public

-quiet

-serialwarn

-source

-sourcepath

-splitindex

-stylesheetfile

-subpackages

-tag

-taglet

-tagletpath

-title

-use

-verbose

-version

-windowtitle

/

@author

@param name

@copy

/

表示的是文档注释,文档注释里可以以作者名,参数的意义,版本等等。对于方法的文档注释,可以在方法的上面输入逗/地按回车,就会出来了

1、单行(single-line)--短注释://……

单独行注释:在代码中单起一行注释,

注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。

注释格式:/

注释内容

/

行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。

注释格式://

注释内容

行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。

注释格式:代码

+

8(至少4)个空格

+

//

注释内容

2、块(block)--块注释:/……/

注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在html报告中。注释格式通常写成:

/

注释内容

/

3、文档注释:/……/

注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符

//

下列哪种注释方式在java程序中是错误的()

A/注释文字串/

B//注释文字串

C/注释文字串/

DRem注释文字串

正确答案:D

以上就是关于给下面的java程序注释全部的内容,包括:给下面的java程序注释、计算机二级JAVA技巧:javadoc注释、如何写Java文档注释等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!

欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/zz/9270509.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2023-04-26
下一篇2023-04-26

发表评论

登录后才能评论

评论列表(0条)

    保存