JAVA 文档注释,类的说明,HTML说明文档的生成
有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用。
所以我们需要做一个类的说明文档。
可以采用在.java类里面进行注释,通过注释来生成类的说明文档的方法。
一、.java中注释的写法:
Test1.java
/*
文档注释
*/
/**
此类是对数组进行取最值,排序等操作的
@author 张三
@version 1.0
*/
public class Test1{
/**
取Int数组里面的最大值
@param arr 传入一个int数组
@return 返回一个Int数值
*/
public static int max(int[] arr){
int j = arr[0];
for(int i=0;i<arr.length;i++){
if(j<arr[i]){
j = arr[i];
}
}
return j; }
/**
取Int数组里面的最小值
@param arr 传入一个int数组
@return 返回一个Int数值
*/
public static int x(int[] arr){
int j = arr[0];
for(int i=0;i<arr.length;i++){
if(j>arr[i]){
j = arr[i];
}
}
return j;
}
}
ps:
注释采用/**开始,用*/结尾
@author 作者
@version 版本
@param arr 传入的值 (arr是方法参数名称,是什么参数名,这里填写什么,后面“传入的值”,这几个字是参数名的说明)
@return 返回的值 (返回什么填写什么,前面,“返回的值”这几个字是返回值的说明)
注意:此类要写public 否则无法生成说明文档
二、在dos中采用以下命令生成说明文档
javadoc -d Mydoc1 -author -version Test1.java
ps:
1、以上命令Mydoc1是生成后的文件保存目录
2、-author是生成作者
3、-version是生成版本号
三、生成后的说明文档文件结构截图:
生成后,保存的文件是网页文件.html的,双击index.html即可用浏览器打开查看
查看效果截图:
在这个说明文档中,有构造函数的说明,如果我们需要取消,只需要把构造函数定义为私有的,就可以了,代码如下:
/*
文档注释
*/
/**
此类是对数组进行取最值,排序等操作的
@author 张三
@version 1.0
@addDate 2015-05-31
*/
public class Test1{
private Test1(){ }
/**
取Int数组里面的最大值
@param arr 传入一个int数组
@return 返回一个Int数值
*/
public static int max(int[] arr){
int j = arr[0];
for(int i=0;i<arr.length;i++){
if(j<arr[i]){
j = arr[i];
}
}
return j; }
/**
取Int数组里面的最小值
@param arr 传入一个int数组
@return 返回一个Int数值
*/
public static int x(int[] arr){
int j = arr[0];
for(int i=0;i<arr.length;i++){
if(j>arr[i]){
j = arr[i];
}
}
return j;
}
}
JAVA 文档注释,类的说明,HTML说明文档的生成的更多相关文章
- myeclipse中java文件头注释格式设置
转载:http://www.blogjava.net/yxhxj2006/archive/2014/01/14/408940.html myeclipse中java文件头注释格式设置 windows ...
- Effective Java 第三版——56. 为所有已公开的API元素编写文档注释
Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所 ...
- 如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主 ...
- Java入门基础,必读!Java单行、多行和文档注释!
在编写Java的过程中,我们需要对一些程序进行注释.除了方便自己阅读之外,我们还需要为他人更好地理解我们的程序.因此,我们需要对一些程序进行注释,这些注释可以是编程思想,也可以是程序的作用,可以说是J ...
- 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释
原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 1.文件注释 文件注释就在每一个文件开头 ...
- Java中关于注释、标识符、变量、常量、数据类型、类型转换、转移字符以及数值型的表现形式的详解
Java文件的注意事项 在同一个Java文件中,可以定义多个类,但是被public修饰的类只能够有一个,并且此类名要与文件名一致. 在同一个类中,可以定义多个方法,但是名字叫做main的方法只能有一个 ...
- Java常用API(Random类)
Java常用API(Random类) Random:是一个用于生成随机数的类 构造方法 public Random() :创建一个新的随机数生成器. 返回随机数的方法 public int nextI ...
- java基础课程笔记 static 主函数 静态工具类 classpath java文档注释 静态代码块 对象初始化过程 设计模式 继承 子父类中的函数 继承中的构造函数 对象转型 多态 封装 抽象类 final 接口 包 jar包
Static那些事儿 Static关键字 被static修饰的变量成为静态变量(类变量) 作用:是一个修饰符,用于修饰成员(成员变量,成员方法) 1.被static修饰后的成员变量只有一份 2.当成员 ...
- java文档注释--javadoc的用法
1.前言 Java中有三种注释方式.前两种分别是 // 和 /* */,主要用于代码的注释,以此来方便代码的可读性.第三种被称作说明注释或文档注释,它以 /** 开始,以 */结束,文档注释允许你在程 ...
随机推荐
- springMvc源码学习之:spirngMVC获取请求参数的方法2
@RequestParam,你一定见过:@PathVariable,你肯定也知道:@QueryParam,你怎么会不晓得?!还有你熟悉的他 (@CookieValue)!她(@ModelAndView ...
- Linux comands
https://www.mankier.com/8/vmstat http://docs.oracle.com/cd/E23824_01/html/821-1451/spmonitor-22.html ...
- 使得<li>在一行显示,去除浮动的方法
①<li>使用浮动的方法,但是要用div包裹起来,该父元素需要设置宽度与高度: <!DOCTYPE html> <html> <head> <me ...
- kvo-观察者-iOS
#import <Foundation/Foundation.h> @interface Child : NSObject @property (nonatomic,assign) int ...
- EasyUI之DataGrid使用
http://blog.csdn.net/liovey/article/details/9173931 背景介绍: 原 先项目采用普通的jsp页面来做为前端显示,用户体验差,并且为了实现某一种效果需要 ...
- 002. 在HTML页面嵌入循环代码
<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default2.aspx.cs ...
- linux包之procps之vmstat命令
概述 [root@localhost ~]# rpm -qf /usr/bin/vmstatprocps-3.2.8-25.el6.x86_64 vmstat是一个很全面的性能分析工具,可以观察到系统 ...
- winform 调用http 通过代理出现的一系列问题
如果遇到以上问题,请拷贝以下代码到你的桌面应用程序的app.config 文件中 <system.net> <defaultProxy enabled="false&quo ...
- 水晶报表连接Oracle做数据报表笔记
首先,新建一个水晶报表的文件,这个时候要给这个报表文件绑定一个oracle数据源, 选择右侧菜单的这个东西,选择“数据库专家”,打开之后是这么一个界面: 选择建立新连接: 这个地方最关键,也是我为什么 ...
- IntelliJ IDEA常用快捷键
双击shift 项目所有目录查找 ctrl+f 文件查找特定内容 ctrl+shift+f 项目查找包含特定内容的文件 ctrl+n 新建类 ctrl+shift+n 查找文件 ctrl+e 最近的 ...