【javadoc命令的用法】

1.java源文件里,注释以/**开始 并以*/结束,里面可以包含普通文件,HTML标记和javaDoc标记。这些将构成javaDoc文档。

2.javadoc命令只能处理java源文件中在类声明,接口声明,成员方法声明,成员变量声明及构造方法声明之前的注释,忽略位于其它地方的注释。如 局部变量前的注释,即使符合规范也会被javadoc命令忽略。

3.常见的javadoc标记

@version 指定版本信息

@since 指定最早出现在那个版本

@author 指定作者

@see 生成参考其它javaDoc文档的链接

@link 生成参考其它javadoc文档的链接,它和 @see标记的区别在于@link标记能够嵌入到注释语句中,为注释语句中的特定词汇生成链接。

@deprecated 用来标明被注释的类,变量或方法已经不提倡使用,在将来的版本中可能被废弃。

@param 描述方法的参数

@return 描述方法的返回值

@throws 描述方法抛出的异常,指明抛出异常的条件

4.javadoc命令既可以处理包,也可以处理java源文件.

javadoc[option][packagenames][sourcefiles]

javadoc命令的主要选项:

-public 仅为public访问级别的类及类的成员生成javaDoc文档

-proteceted 仅为public和protected访问级别的类及类的成员生成javadoc文档.

(默认选项)

-package 仅为public, protected和默认访问级别的类及类的成员生成

javaDoc文档

-private 为public,protected,默认和private访问级别的类及类的成员生成javadoc文档

-version 解析@version标记

-author 解析@author标记

-splitindex 将索引分为每个字母对应一个索引文件

-sourcepath 指定java源文件的路径

-classpath 指定classpath

-d 指定javaDoc文档的输出目录

javadoc命令的几个选项的用法:

-public,-protected,-package和-private这4个选项用于指定输出那些访问级别的类和成员的javaDoc文档.其中protected为默认选项。

-version和-author选项指定在javaDoc文档中包含由 @version和@author标记指示的内容。这两个选项不是默认选项。在默认情况下,javadoc命令会忽略注释中的 @version和@author标记,因此生成的javaDoc文档中不包含版本和作者信息。

欢迎来到技术之家,

如需转载,烦请保留本文链接和出处:http://www.jszja.com/contents/14/704.html

您的支持将是我们前进的动力!如对本篇文章有疑问或建议,请通过本站下方邮箱联系我们,让技术之家每天进步一点点!(●'◡'●)

java中解释命令_闲来无事可来了解下Java中Javadoc命令的用法相关推荐

  1. java执行python脚本_使用Runtime.getRuntime().exec()在java中调用python脚本

    举例有一个Python脚本叫test.py,现在想要在Java里调用这个脚本.假定这个test.py里面使用了拓展的包,使得pythoninterpreter之类内嵌的编译器无法使用,那么只能采用ja ...

  2. java 编译 解释执行_关于Java的编译执行与解释执行

    编程语言分为低级语言和高级语言,机器语言.汇编语言是低级语言,C.C++.java.python等是高级语言. 机器语言是最底层的语言,能够直接执行.而我们编写的源代码是人类语言, 计算机只能识别某些 ...

  3. 为什么java中floatda正确_为什么cast to float在java中产生正确的结果?

    文档没有特别好地解释,但 Double.toString(double)基本上在它产生的输出中执行一些舍入. Double.toString算法在整个Java SE中使用,包括例如System.out ...

  4. java 变量名 字符串_如何使字符串值在java中调用特定的现有JButton变量名?

    所以,我知道有这样的: int number = Integer.parseInt("5"); String numtxt = Integer.toString(12); doub ...

  5. 中科方德java开发编码规范_插件推荐:如何将Java编码规范落地实际开发中

    一个软件需要花费80%的生命周期成本去维护. 几乎没有任何软件的整个生命周期仅由其原作者来维护. 编码规范改善软件的可读性,让工程师更快更彻底地理解新的代码. 如果你将源代码转变为一个产品,那么您需要 ...

  6. Java游戏守卫者_我的世界:当java版玩家遇上基岩版玩家,原来MC中也存在语言不通...

    原标题:我的世界:当java版玩家遇上基岩版玩家,原来MC中也存在语言不通 事情起因:有小伙伴投稿,说自己被同学拉入了一个<我的世界>群聊,自己原准备大侃特侃,但发现他们聊的东西跟自己玩的 ...

  7. java grpc 服务路由_.NET Core 3.0 Preview 3中关于ASP.NET Core的更新内容

    原标题:.NET Core 3.0 Preview 3中关于ASP.NET Core的更新内容 英文:devblogs.microsoft.com 来源:艾心 译文:cnblogs.com/ediso ...

  8. java 代码名称转换_计算机编码基础知识及Java中编码转换

    1.ASCII 码 学过计算机的人都知道 ASCII 码,ASCII 码是美国标准信息交换代码(American Standard Code for Information Interchange)的 ...

  9. rn在java中什么意思_[React Native Android 安利系列]RN中使用js调用java代码

    欢迎大家收看react-native-android系列教程,跟着本系列教程学习,可以熟练掌握react-native-android的开发,你值得拥有: 书接上节,我们上节说道,如何控制原生andr ...

最新文章

  1. mysql定时备份并上传ftp_Linux下定时任务实现mysql自动备份并上传远程ftp
  2. C语言嵌入式系统编程修炼
  3. TCP/IP协议精华指南pdf发布
  4. leetcode 1482. 制作 m 束花所需的最少天数(二分查找)
  5. MySQL普通索引与唯一索引__mysql中唯一索引和普通索引的用途及区别
  6. mysql注入内置函数_PHP面试之mysql内置函数,xss漏洞,sql注入
  7. Android环境配置(Eclipse全开发环境下载)
  8. Go语言学习之11 日志收集系统kafka库实战
  9. 设计模式(三): FACTORY工厂模式 -- 创建型模式
  10. linux mysql 密码策略_linux密码策略
  11. CE修改器入门:运用代码注入
  12. linux 桌面小部件,在Ubuntu中安装桌面小部件 | MOS86
  13. charles 本地IP地址
  14. Volatility 工具分析
  15. 数据结构课设——计算器
  16. 采用Tagged Pointer的字符串
  17. 第9章 Quartz定时器和发送Email
  18. 一个字节有多少位(๑′ᴗ‵๑)
  19. Codeforces Round #655 (Div. 2) D
  20. 英语话题 Life experience

热门文章

  1. Python库:Pyinstaller库、pip工具、pip指定安装源和版本
  2. form表单属性名相同java_form表单提交 list对象给Java 后台结合
  3. adprw指令通讯案例_实例 | 三菱FX3U485无协议通讯程序详解(含程序)
  4. java的Random类
  5. easyui datagrid加载数据的三种方式
  6. android端和javaWeb端实现Mqtt消息推送
  7. 如何用python做界面_Python+AutoIt实现界面工具开发
  8. 计算机实验室工作案例,2011年计算机学院实验室工作计划.
  9. Pyqt5:使用多线程QThread
  10. 用unity制作能量护盾(3)