您的位置:首页 > 编程语言 > Java开发

java的文档注释

2015-08-20 22:05 411 查看
/*

软件 = 数据 + 指令 + 文档(使用者文档+ 开发者文档)

文档注释与多行注释的区别:

多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,

而文档注释 的内容可以生产一个开发者文档。

使用javadoc开发工具即可生成一个开发者文档。

javadoc工具的使用格式:

javadoc -d 存放文档的路径   java的源文件


使用javadoc工具要注意细节:

1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。

2. 文档注释注释的内容一般都是位于类或者方法的上面的。

写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的。

*/

/**

该类是用于模拟QQ软件的

@author 1208JAVA基础班全体同学

@version 1.0

*/

public class Demo3 {

/**
操作的流程如下:
1.首先先输入用户名密码
2. 校验用户名与密码
3. 展示好友列表
*/
public static void main(String[] args) {
System.out.println("请输入用户名与密码");  //这句话是用于输入用户名与密码的。
System.out.println("校验用户名与密码");
System.out.println("展示好友列表");
}


}
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  java