Java 之 看透她的心 《Java文档》
来源:互联网 发布:dotamax数据更新 编辑:程序博客网 时间:2024/09/21 09:01
要说Java文档,我先来介绍一下Java的注释方式。程序注释对写程序来说,是至关重要的。既要整洁,也要关键。
Java的注释有三种: 1.段落注释:/* 注释部分
第二行注释 */
2.单行注释://就这一行注释
3.文档注释: /** 我是文档注释
一般有若干行 */
第三种注释,可以出现在每个类或接口前,也可以在方法(就是函数)前。而生成Java文档,就是根据文档注释来生成的。
生成工具:javadoc。javadoc.exe 工作在JDK的bin目录下。会输出HTML格式的文件。即Java文档。
命令行输入命令:javadoc FileName.java (注意路径)
之后便会在当前文件夹生成很多HTML文件。打开index.html,就可以浏览Java文档了。
javadoc标记:由@和后边的标记类型和注释内容组成。加入文档注释中后,生成的Java文档可以显示相应特殊注释。
常用的标记:
@author 生成作者信息项;
@ version 指定版本信息;
@see 提供其他类、方法、变量的链接;
@param 什么方法的形参;
@return 什么方法的返回值;
@exception 定义方法可能抛出的异常;
@throws 同@exception;
@deprecated 方法已过时;
@serialData 说明写入或读取的数据项;
@serialField 什么一个ObjectStreamField对象;
@serial 什么一个可以串行化的类的一个成员变量;
@since 指出一项功能什么时候可以被加入到程序代码中。
0 0
- Java 之 看透她的心 《Java文档》
- 失败啊失败,玩Java这么久,今天才下载了她的文档
- 通过JAVA SWING看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过 Java Swing 看透 MVC 设计模式
- 通过 Java Swing 看透 MVC 设计模式
- 通过 Java Swing 看透 MVC 设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 通过Java Swing看透MVC设计模式
- 《看透springMVC源码》之Tomcat的生命周期
- 看透女人心,从她喝酒表现开始
- 你想学习JAVA,那你了解她的历史背景吗?
- 要在win7上装个苹果操作系统
- C#中的parse什么意思?
- 进程间通信,线程间同步
- 基于数据库的温度采集上传系统
- 三分算法学习
- Java 之 看透她的心 《Java文档》
- 射频宽带放大器-国电
- [Android] 调试native代码时查看错误stack
- Linux sed 使用
- getAbsolutePath、getCanonicalPath、FileInputStream、FileOutputStream
- Linux ssh 免密码登入远程服务器
- ACM POJ 2593 Max Sequence ----最大子段和问题
- 福晶科技当空参加过花电话费吃喝是滴
- Codeforces Round #267 (Div. 2) 解题报告