精华内容
下载资源
问答
  • java生成文档注释
    2021-03-16 15:38:55

    使用eclipse生成文档(javadoc)主要有三种方法:

    1.  在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。

    在Javadoc Generation对话框中有两个地方要注意的:

    javadoc command:应该选择jdk的bin/javadoc.exe

    destination:为生成文档的保存路径,可自由选择。

    按finish(完成)提交即可开始生成文档。

    2.  用菜单选择:File->Export(文件->导出),

    剩下的步骤和第一种方法是一样的。

    3.  选中要生成文档的项目,然后用菜单选择,

    Project->Generate Javadoc直接进入Javadoc Generation对话框,剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

    =================================================================

    导出的时候可能会出现因为乱码而导出失败,给 javadoc.exe 加上编码参数就OK。

    具体的:

    在Eclipse里 export 选 JavaDoc,在向导的最后一页的Extra JavaDoc Options 里填上参数即可

    比如项目采用的是UTF-8的编码就填:-encoding UTF-8-charset UTF-8

    更多相关内容
  • Java生成文档注释

    2019-09-04 19:43:29
    在实际开发中,我们经常需要生成文档注释,下面简单记录一下如何生成文档注释,以下是使用EditPlus编写的java文档生成的注释。 帮助文档: 1)使用JDK,JDK中类有很多,都可以使用,了解这些类的使用方式,类的功能,变量,...

    在实际开发中,我们经常需要生成文档注释,下面简单记录一下如何生成文档注释,以下是使用EditPlus编写的java文档生成的注释。
    帮助文档:
    1)使用JDK,JDK中类有很多,都可以使用,了解这些类的使用方式,类的功能,变量,方法,怎么使用, JDK给开发人员提供了帮助文档 API
    2)自己的项目中,开发的功能,需要给客户提供对应的操作手册,方便客户进行功能的运行

    注释: 文档注释,注释中包含了一些注解,能针对于写的类或者方法进行比较具体和详细的描述, 文档注释可以生成帮助文档

    dos命令生成操作手册:
    javadoc -d api -author -version 源文件

    javadoc : JDK的bin路径下的一个命令,作用生成操作手册(帮助文档)
    -d : directory 表示目录的意思生成的操作文档会存放在一个目录(文件夹)下
    api : 存放操作手册文档的目录
    author : 表示操作手册中会生成作者
    version : 表示操作手册中会生代码版本
    源文件: 想要让哪个类生成对应的文档,源文件写上

    生成了操作文档后,到api文件夹下,找到index.html,双击查看

    java文件示例:

    /**
    @author xlt
    @version 1.0
    
    */
    public class ArrMax {
    	public static void main(String[] args) 
    	{
    		int[] arr = {2,3,-9,99,78,-1};
    		int max = getMax(arr);
    		System.out.println(max);
    	}
    	/**
    	求数组最大值
    	@param arr 数组
    	@return max,输出数组最大值
    
    */
    	public static int getMax(int[] arr){
    		if(arr!=null&&arr.length!=0){
    			int max = arr[0];
    		for(int i =0;i<arr.length;i++){
    				if(max<arr[i]){
    					max = arr[i];
    				}
    	   
    		}
    		return max;
    		
    		
    		}else{
    		
    			System.out.println("数组不能为null或者数组长度不能为0");
    			return 0;
    		}
    		
    	
    	}
    }
    
    

    接下来找到文件,生成注释,打开cmd命令
    在这里插入图片描述
    生成之后接下里打开api文件夹中查看
    在这里插入图片描述
    双击打开一个叫做index.html的网页文件,就是操作文档
    在这里插入图片描述

    展开全文
  • * 这是我的java文件的文档注释 * 换行了 * 看看会发生什么 */ // 类名要和文件名一致 public class Hello{ public static void main(String[] args){ System.out.println("Hello world!"); } } 生成自定义java...

    使用javadoc注释

    注释语法:

    /**…*/

    范例

    /**
    *
    * 这是我的java文件的文档注释
    * 换行了
    * 看看会发生什么
    */
    // 类名要和文件名一致
    
    public class Hello{
    	public static void main(String[] args){
    		System.out.println("Hello world!");
    	}
    }
    

    生成自定义java文档

    注意:先要进入当前java文件所在的文件目录,这里我的java文件放在了根目录
    javadoc -d 放置的磁盘:\放置的目录 -author -version 类名.java
    生成文档

    生成完毕

    生成
    点击类名.html可以看到里面的java文档注释内容
    在这里插入图片描述

    控制台编译和运行

    编译和运行也需要进入到当前目录下
    编译和运行

    展开全文
  • 下面小编就为大家分享一篇Java文档注释生成帮助文档的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
  • 文章目录HelloWorld的程序分析代码格式 HelloWorld的程序分析 ...java代码的位置 java是严格区分大小写的 java是一种自由格式的语言 代码分为结构定义语句和功能执行语句 功能执行语句的最后必须用分号隔开 ...

    HelloWorld的程序分析

    写

    代码格式

    java代码的位置
    java是严格区分大小写的
    java是一种自由格式的语言
    代码分为结构定义语句和功能执行语句
    功能执行语句的最后必须用分号隔开

    javadoc

    在命令窗口,java所在文件夹下,
    输入javadoc *.java;表示将此文件夹中的java文件都生成文档注释
    也可javadoc HelloWorld.java;生成单个java文件的文档注释

    javadoc的使用方式

    javadoc -help;此命令可以显示javadoc如何使用
    在这里插入图片描述
    在这里插入图片描述

    GBK编码问题

    当输入javadoc生成文档注释的时候,如果出现GBK编码错误.
    这是因为java编辑时使用的编码格式与cmd命令窗口的编码格式不一致造成的.
    这时只需要点击"HelloWorld.java文件"编辑,之后另存为,如图所示.
    在这里插入图片描述
    在这里插入图片描述
    编码"ANSI"对应的就是GBK编码格式.

    使用javadoc形成文档注释

    未使用时
    在这里插入图片描述
    使用"javadoc HelloWorld.java"后;
    在这里插入图片描述
    在这里插入图片描述
    点击"index.html"看文档注释.
    在这里插入图片描述

    展开全文
  • 文档注释:如果编写Java源代码是添加了合适的文档注释,然年后通过JDK提供的Javadoc工具可以直接将源代码里面的文档注释提取成一份系统的API文档文档注释适用于生成API文档的,javadoc工具只处理Public和protect*...
  • 所以我们可以手动调用javadoc工具来生成文档,或者通过IDE生成。当然IDE也是调用javadoc,不过更快更省事。 注释的书写方式:https://blog.csdn.net/weixin_43670802/article/details/105612176 javadoc的用法 ...
  • 通过spring插件库实现注释文档生成; 步骤: 1、修改App.java中的几个配置信息; 2、运行App.java中的main方法; 之后即生成了代码中带规范注释的api文档
  • 文章目录类注释--1打开IDEA-->File-->...File and Code Templates选择Files 下的class,然后添加每创建一个类都会自动生成一个类注释,如下类注释选择一个方法即可,不必重复操作方法注释打开IDEA--&
  • * @version java1.8 */ public class demo1 { /** * 该类的无参构造方法 */ public demo1() { } /** *获取两数之和 * @param a 加数 * @param b 被加数 * @return 经过if语句判断后返回的String值
  • Java文档注释

    千次阅读 2022-02-14 23:20:45
    文档注释:在程序中采用特定的注释格式进行注释,然后通过JDK提供的工具javadoc来解析,生成一套以网页文件形式体现的程序说明文档。一般写在类。 2. 简单使用演示 演示程序DocComment.java: /** * @author 小明...
  • Java的方法或类上生成注释的快捷键
  • 这是一个有文档注释/** */的java代码: notepad++中鼠标右键—》选择 “打开所在文件夹(命令行)” —》cmd中已经进入改文件所在目录,输入命令“javadoc -d myFirstJava -author -version HelloWorld3.java” ...
  • Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档。Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/。 Eclipse怎么生成API...
  • 生产JAR文档 ...Generate JavaDoc… ...注意:如果在生成过程中,需要注意生成文档的编码与项目的编码是一致。如果在直接点击Generate Javadoc默认是gbk.所以一般点击next在最后一部点击固定编码格式 ...
  • Java 程序的新增编译运行,注释、代码格式、文档注释生成文档
  • Java-文档注释

    2021-03-13 23:44:28
    Java-文档注释Java语言支持三种类型的注释-Sr.No.Comment & Description1/* text */The compiler ignores everything from /* to */.2//textThe compiler ignores everything from // to the end of the line.3/...
  • 一、项目文档开头注释/** * 1.类的描述&&详细功能介绍 * 2.Author ..... * /二、每个方法的注释... * /三、重难点或难理解代码注释JAVA生成自己项目的API文档步骤:生成后打开保存路径,在里面直接打开index文件即可
  • 一款java接口文档自动生成的插件,包含了根据接口注释或注解自动生成接口文档,可网页打开,使用spring+vue开发,告别传统手写接口文档,告别swagger臃肿视图和阉割功能,提供了生成、管理及使用等全方位功能。...
  • Java 文档注释

    2021-01-03 03:47:00
    Java 文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出...
  • java规范了三种注释方式:单行注释、多行注释、文档注释(Java特有的) 二、多行注释 三、文档注释 四、单行注释和多行注释的作用 1)对所写的程序进行解释说明,增强可读性,方便自己,方便别人。 2)可以调试所写...
  • 在创建类的时候直接生成注释 两种方法: 按照顺序打开File–>settings–>Editor–>File and Code Templates–>Includes–>File Header 按照顺序打开File–>settings–>Editor–>File and...
  • 前两种分别是 单行注释 // 和 多行注释 /* */ ,第三种是 文档注释 /** */。 在IDEA中,文档注释可以对类、接口、方法、属性等进行描述,提高阅读效率。 文档注释只能写在类、接口、方法、属性等前面,否则无效。 ...
  • 最近从eclipse转idea了,第一步当然是配置快捷键,模板等。...测试版本为idea for mac,可能快捷键不同,但是设置等肯定是相同的生成注释打开PreferencesEditor -> File and Code Templates -> Files -> ...
  • java文档注释的模板设置 在preference > java > code style > code templates > comments 中; 1.类的文档注释模板: /** * @author 输入作者名字 * @version 系统项目版本 ${date} ${time} * @since...
  • Java注释 编写程序时,总要为程序添加一些注释,用以说明某段代码的作用,或者某个类的用途、某个方法的功能,以及该方法的参数及返回值的意义。 为什么要编写注释?主要有一下几个方面的考虑: -永远不要过于...
  • Java支持以下三种注释方式: 1)单行注释 以双斜杠“//”标识,只能注释一行内容,用在注释信息内容少的地方。打开 Eclipse,在 Java 代码中使用单行注释,如图 1 所示。 图 1 单行注释 2)多行注释 包含在...
  • 主要介绍了从HelloWorld和文档注释开始入门Java编程,涉及到Javadoc工具的使用,需要的朋友可以参考下

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 131,275
精华内容 52,510
关键字:

java生成文档注释