电大的网站界面ui设计训练怎么做,c2c的盈利模式,全球知名设计公司,微信公众号第三方管理平台目录 一、JAVADOC#xff08;Java API 文档生成器#xff09;
1.1概述
1.2Javadoc标签
1.3Javadoc命令
1.4用idea自带工具生成API帮助文档
二、IDEA如何生成get和set方法
三、常见快捷方式
3.1快速生成main函数
3.2快速生成println()语句
3.3快速生成for循环
3.4“…目录 一、JAVADOCJava API 文档生成器
1.1概述
1.2Javadoc标签
1.3Javadoc命令
1.4用idea自带工具生成API帮助文档
二、IDEA如何生成get和set方法
三、常见快捷方式
3.1快速生成main函数
3.2快速生成println()语句
3.3快速生成for循环
3.4“ifn”快速生成if(null)语句
3.5Ctrl /注释或取消当前行
3.6注释 一、JAVADOCJava API 文档生成器
1.1概述 Javadoc是Java SE中的一个工具文档注释以/**开头并以*/结束可以通过 Javadoc 生成一个和源代码配套的 API 帮助文档Java 帮助文档主要用来说明类、成员变量和方法的功能。 文档注释只放在类、接口、成员变量、方法之前因为 Javadoc 只处理这些地方的文档注释而忽略其它地方的文档注释。 1.2Javadoc标签 Javadoc工具可以识别文档注释中的一些特殊标签这些标签一般以开头后跟一个指定的名字有的也以{开头以}结束 Javadoc标签必须从一行的开头开始否则将被视为普通文本。一般具有相同名称的标签放在一起。Javadoc标签区分大小写代码中对于大小写错误的标签不会发生编译错误但是在生成API帮助文档时会检测不到该注释内容。3 标签描述示例author标识一个类的作者一般用于类注释author descriptiondeprecated指名一个过期的类或成员表明该类或方法不建议使用deprecated description{docRoot}指明当前文档根目录的路径Directory Pathexception可能抛出异常的说明一般用于方法注释exception exception-name explanation{inheritDoc}从直接父类继承的注释Inherits a comment from the immediate surperclass.{link}插入一个到另一个主题的链接{link name text}{linkplain}插入一个到另一个主题的链接但是该链接显示纯文本字体Inserts an in-line link to another topic.param说明一个方法的参数一般用于方法注释param parameter-name explanationreturn说明返回值类型一般用于方法注释不能出现再构造方法中return explanationsee指定一个到另一个主题的链接see anchorserial说明一个序列化属性serial descriptionserialData说明通过 writeObject() 和 writeExternal() 方法写的数据serialData descriptionserialField说明一个 ObjectStreamField 组件serialField name type descriptionsince说明从哪个版本起开始有了这个函数since releasethrows和 exception 标签一样.The throws tag has the same meaning as the exception tag.{value}显示常量的值该常量必须是 static 属性。Displays the value of a constant, which must be a static field.version指定类的版本一般用于类注释version info 对两种标签格式的说明 tag 格式的标签不被{ }包围的标签为块标签只能在主要描述类注释中对该类的详细说明为主要描述后面的标签部分如果块标签放在主要描述的前面则生成 API 帮助文档时会检测不到主要描述。{tag} 格式的标签由{ }包围的标签为内联标签可以放在主要描述中的任何位置或块标签的注释中。 1.3Javadoc命令 javadoc命令是用来生成自己API文档的使用方式使用命令行在目标文件所在目录输入javadoc 文件名.java Javadoc 用法格式如下
javadoc [options] [packagenames] [sourcefiles]
对格式的说明
options 表示 Javadoc 命令的选项packagenames 表示包名sourcefiles 表示源文件名。
在 cmd命令提示符中输入javadoc -help就可以看到 Javadoc 的用法和选项前提是安装配置了JDK下面列举 Javadoc 命令的常用选项
名称说明 -public 仅显示 public 类和成员-protected显示 protected/public 类和成员默认值-package显示 package/protected/public 类和成员-private显示所有类和成员-d directory输出文件的目标目录-version包含 version 段-author包含 author 段-splitindex将索引分为每个字母对应一个文件-windowtitle text文档的浏览器窗口标题
1.4用idea自带工具生成API帮助文档
1. 在IDEA中选择工具Tool选项卡打开并选择Generate JavaDoc生成javaDoc 2.配置各种参数 第一步选择生成JavaDoc文档的范围我只对一个源文件生成Doc所以选择文件。 第二步输出目录最好新建一个文件夹比较有条理和整洁 第三步区域设置决定文档的语言简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww 第四步其他命令行参数如果区域设置为中国参数一般为 -encoding UTF-8 -charset UTF-8 主要意义是为了显示中文不出现乱码 第五步设置完成后点击确定即可生成Doc文档
3.查看生成文档
打开输出目录就可看到成功生成打开 index.html 便能看生成的文档。 二、IDEA如何生成get和set方法
可以用快捷键AltInsert来实现 选择我们想要生成的get 和set
选择属性 生成代码 三、常见快捷方式
3.1快速生成main函数 psvm是IDEA中的一个快捷键它可以快速生成main函数。 3.2快速生成println()语句 使用sout来快速生成System.out.println()语句 3.3快速生成for循环 可以使用fori来快速生成for循环 3.4“ifn”快速生成if(null)语句
3.5Ctrl /注释或取消当前行
3.6注释 Ctrl Shift /注释多行Ctrl Shift \取消多行注释 3.7按ctrl加鼠标左键 在IntelliJ IDEA中按下Ctrl键并单击鼠标左键可以跳转到光标所在的符号的定义处。这个快捷键可以用于查看方法、类、变量等的定义。 3.8复制当前行并将其插入到下一行 在IntelliJ IDEA中按下Ctrl D可以复制当前行并将其插入到下一行。如果没有选中任何文本那么复制整个当前行。如果选中了一些文本那么复制选中的文本并将其插入到下一行。这个快捷键可以用于快速复制和粘贴代码。 3.9Alt Enter显示建议的操作列表。
