为什么要为程序添加注释,在java程序中如何为程序添加注释?

为什么要为程序添加注释,在java程序中如何为程序添加注释?,第1张

定义规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项陪袜山目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)。

// 注释一行  

/* ...... */ 注释若干行  

/** ...... */ 注释若干行,并写入好凯 javadoc 文档芦中

如下代码:

package com.qiu.lin.he

/**

 * 第三种注释方式

 * @author Administrator

 *

 */

public class CeShi {

public static void main(String[] args) {

int str = 107653

//System.out.print(str / (24 * 60 * 60) + "天")

/*System.out.print(str % (24 * 60 * 60) / (60 * 60) + "小时")

System.out.print(str % (24 * 60 * 60) % (60 * 60) / 60 + "分钟")*/

System.out.print(str % (24 * 60 * 60) % (60 * 60) % 60 + "秒")

}

}

我看动力节点的java基础大全301集教中的三种注释方法

1、单行注释   //注释的内容

2、多行注拍模释  /*......*/

3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记:

特别声明:

(1)javadoc针对public类生成注释文档

(2)javadoc只能在public、protected修饰的方法或者属性之上

(3)javadoc注释的格式化:前导*号和HTML标签

(4)javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用:

(1)首先编写.java文件

(2)在命令行中执行以下dos命令:

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记:是@开头的,对javadoc而言,特殊的标记。

(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件

附上代码:

[java] view plain copy

<span style="font-size:18px">*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name

/**这是main方法,是程序的入口

*@param args 用户输入参数

*/

public static void main(String[] args){

System.out.println("Hello World!")

f1()

}

/** 这是第1个方法,其作用是...*/

public static void f1(){

System.out.println("f1()!")

}

}</span>

[java] view plain copy

<span style="font-size:18px">import java.io.IOException

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*<br>链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

/**非public,protected 属性袭丛缓上的注释不生成*/

public String name

/**这是main方法,是程序的入口

*@param args 用户输入的参数,是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!")

f1()

f2(1)

}

/**这是第一个方法,其作用是....

*@deprecated 从版本1.2开始,不再建议使用此方法

*/

public static void f1(){

System.out.println("郑宽fl()!")

}

/**这是第二个方法,其作用是....

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

System.out.println("f1()!")

return "OK"

}

} </span>

注意:

如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version -author

javadoc -version -author -d doc *.java

(其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息)

也不知道你是想问怎么写文档注释,还只是把代码注释一边!

得了我全帮你给整了吧..就当练习一次了!

/**

<P>1.编写 Java 程序用于显示人的姓名和年龄。

<P>2.定义一个人类Person。 该类中应该有两个[私有]属性: 

<P>3.姓名 (name) 和年龄 (age) 。

<P>4.定义构造方法用来初始化数据成员。

<P>5.再定义显示(display()) 方法将姓名和年龄打印出来。

<P>6.在 main 方法中创建人类的实例然后将信息显示。

@author 作者名烂没字

@version 版本号

*/

package com.baidu.zq01//包路径!

class Person    //类名!

{

/**

 私有成员属性!

*/

private String name

private int age

/**

空构造方法

*/

public Person()

{

}

/**

形参构造方法

@param name 参数name传入值!

@param age 参数age传入值!

*/

public Person(String name, int age)

{

this.name = name

this.age = age

}

/**

 对外提供一个获取成员变量name的方法!

@return 返回一个name的值!

*/

public String getName()

{

return name

}

/**

  对外公开修改成员属性name的值!

@param name 传入一个name值赋给成员变量!

*/

public void setName(String name)

{

this.name = name

}

/**

  对外提供一个可以获取age值的方法!

@return 返回一个int类型的age

*/

public int getAge()

{

return age

}

/**

  对外公开修改成员属性age的值!

@param age 传入一个age值赋给成员变量!

*/

public void setAge(int age)

{

this.age = age

}

/**

  对外提供一个方法获取并打印出饥含纳成员变量!

*/

public void display() 

{

System.out.println("我的名字是:老亩"+name+",我今年"+age+"岁了")

}

}

//主类

public class TestPerson 

{

public static void main(String[] args)

{

//创建对象,通过形参构造函数,传值初始化来进行创建!

Person p = new Person("张强",6)

//调用对象的display方法!

p.display()

}

}

生成的帮助文档我没办法给你啊,给你截图吧!


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

原文地址: http://outofmemory.cn/yw/12321013.html

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

发表评论

登录后才能评论

评论列表(0条)

保存