java的文档注释
2015-08-20 22:05
411 查看
/*
软件 = 数据 + 指令 + 文档(使用者文档+ 开发者文档)
文档注释与多行注释的区别:
多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,
而文档注释 的内容可以生产一个开发者文档。
使用javadoc开发工具即可生成一个开发者文档。
使用javadoc工具要注意细节:
1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
2. 文档注释注释的内容一般都是位于类或者方法的上面的。
写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的。
*/
/**
该类是用于模拟QQ软件的
@author 1208JAVA基础班全体同学
@version 1.0
*/
public class Demo3 {
}
软件 = 数据 + 指令 + 文档(使用者文档+ 开发者文档)
文档注释与多行注释的区别:
多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,
而文档注释 的内容可以生产一个开发者文档。
使用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对世界各个时区(TimeZone)的通用转换处理方法(转载)
- java-注解annotation
- java-模拟tomcat服务器
- java-用HttpURLConnection发送Http请求.
- java-WEB中的监听器Lisener
- Android IPC进程间通讯机制
- Android Native 绘图方法
- Android java 与 javascript互访(相互调用)的方法例子
- 介绍一款信息管理系统的开源框架---jeecg
- 聚类算法之kmeans算法java版本
- java实现 PageRank算法
- PropertyChangeListener简单理解
- 插入排序
- 冒泡排序
- 堆排序
- 快速排序
- 二叉查找树
- [原创]java局域网聊天系统