java java.doc_使用 javadoc 自动生成 Java 文档

Java 的注释,单行,多行的语法就不在赘述了。

javadoc tags

给 Java 源码文件书写注释,使用常见的 Java 注释可以实现一些,也可以通过如下的 Javadoc 的 Tags 来实现一些特殊的比如跳转,参数返回值等特殊标记。

javadoc 标记有如下一些:

@author 作者名,一般不推荐使用,git blame 基本上能够找到每一行代码的作者

@version 版本号

@see 跳转到相关类或者主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

不过已经不建议在 Java 源文件中使用 @author 标记,现代的 git 完全能够满足模块作者的追溯,甚至可以精确到每一行的作者。

Package doc

上面的方法可以给类,方法,参数等等编写注释,如果要给一个包添加注释,就需要额外添加 package-info.java 的文件。

从 Java 1.5 版本开始可以在包下新建一个名为 package-info.java 的文件,在这个文件中可以使用标准 Java 注释来给 package 书写文档:

com/foo/package-info.java:

/**

* com.foo is a group of bar utils for operating on foo things.

*/

package com.foo;

//rest of the file is empty

注释中的代码

如果要在 javadoc 中书写代码,尤其是想要展示一些例子的时候,不可避免的会用到 以及 @ 等等特殊的符号。Javadoc 默认是 html 的 tag 来渲染格式,所以这种情况下有

 选择,然后 javadoc 还提供了 {@code} 语法。这三个方式都可以用来注释代码,但各自又不相同。

使用 pre 标签

 标记是 html 默认的格式化标签,如果使用 
 标签,那么所有的 html 的标记都需要转义。

/**

*

* public class JavadocTest {

* // indentation and line breaks are kept

*

* @SuppressWarnings

* public List<String> generics(){

* // '@', '' have to be escaped with HTML codes

* // when used in annotations or generics

* }

* }

*

*/

public class PreTest {}

命令行的使用

Java 安装完成之后在 Java Path 的目录中自带了 javadoc 这个命令行,如果不想使用 maven-javadoc-plugin 可以使用这个命令来生成 javadoc.

用法:

javadoc [options] [packagenames] [sourcefiles]

选项:

-public 仅显示 public 类和成员

-protected 显示 protected/public 类和成员 (缺省)

-package 显示 package/protected/public 类和成员

-private 显示所有类和成员

-d 输出文件的目标目录

-version 包含 @version 段

-author 包含 @author 段

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

-windowtitle 文档的浏览器窗口标题

在 Intellij 中调整文件头

Intellij 默认会在创建文件的时候给文件添加一些注释,这些注释可以在如下的设置中修改:

File -> Setting -> Editor-> File and Code Template-> File Header

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/528062.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

java增删改一键生成_easyCode(java自动生成增删改查代码)

【实例简介】读取数据库表结构 自动生成增删改查代码【实例截图】【核心代码】package com.isoftstone.autocoding;import com.isoftstone.autocoding.common.Column;import com.isoftstone.autocoding.common.Table;import com.isoftstone.autocoding.utils.CamelCaseUtils;im…

java8.0 platform图_Java Platform SE binary语言-Java编程32位/64位版(jdk-jeb)下载V8.0.2510.8官方安装版-西西软件下载...

Java编程32位/64位版(jdk-jeb)是一款功能强大的计算机编程语言工具&#xff0c;Java技术让您可以在安全的计算环境下工作和游戏。使用 Java您可以畅玩网络游戏、与世界各地的朋友聊天、计算按揭利息&#xff0c;还可以在 3D 模式下浏览图像&#xff0c;诸多功能不一而足。软件特…

java同时关闭两个窗口_在一个窗口中同时关闭多个窗口的问题(Swing中事件多点传送的问题) | 学步园...

class A{}A中包含有&#xff1a;JFrame frameA;JButton btnA;class B{}B中包含有&#xff1a;final JFrame frameB;Static boolean wantToSave true;frameB.addWindowListener( new WindowAdapter(){pubilic void windowClosing(windowEvent we…

JAVA数组扁平化整合_5种方法实现数组扁平化

数组扁平化概念数组扁平化是指将一个多维数组变为一维数组[1, [2, 3, [4, 5]]] ------> [1, 2, 3, 4, 5]复制代码实现1. reduce遍历数组每一项&#xff0c;若值为数组则递归遍历&#xff0c;否则concat。function flatten(arr){return arr.reduce((result, item)> {retur…

java 线程由浅入深_由浅入深,Java 并发编程中的 Synchronized(一)

synchronized 作用synchronized 关键字是 Java 并发编程中线程同步的常用手段之一。1.1 作用&#xff1a;确保线程互斥的访问同步代&#xff0c;锁自动释放&#xff0c;多个线程操作同个代码块或函数必须排队获得锁&#xff0c;保证共享变量的修改能够及时可见&#xff0c;获得…

java私有变量和_java – 大内部类和私有变量

有一件事我经历了几次,是一个服务类(如JBoss服务),由于助手内部类,它已经变得过大了.我还没有找到打破班级的好办法.这些助手通常是线程.这里有一个例子&#xff1a;/** Asset service keeps track of the Metadata about assets that live on other* systems. Complications i…

java long.max_value,Long + Long不大于Long.MAX_VALUE

If I have an assignmentLong c a b;Is there an easy way to check that a b is not bigger/smaller than Long.MAX_VALUE/Long.MIN_VALUE?解决方案Using Guava, its as simple aslong c LongMath.checkedAdd(a, b); // throws an ArithmeticException on overflowwhich …

php从内存中获取源码_PHP源码分析之变量的存储过程分解

PHP代码如下&#xff1a;$php_var 1;对应C的代码是&#xff1a;zval* c_var; //定义PHP变量指针MAKE_STD_ZVAL(c_var); //初始化PHP变量ZVAL_LONG(c_var,1) ;//赋值ZEND_SET_SYMBL( EG(active_symbol_table), " php_var ", c_var);//注册到全局变量符号表一&…

php有哪些高级扩展,php扩展有哪些

什么是PHP扩展&#xff1f;为PHP提供一些扩展的功能常见的PHP扩展mysql-----提供给PHP操作MySQL数据库的功能gd2----动态创建图像xdebug-----跟踪、调试和分析PHP程序的运行状况查看PHP扩展1.使用phpinfo探针phpinfo()---输出关于PHP配置的信息输出PHP当前状态的大量信息&#…

php pdo 绕过,php-带PDO的忘记密码脚本(需要解密)

我可能有一个愚蠢的愚蠢的问题……我正在做一个被遗忘的密码脚本(当然是登录系统),但是我被卡住了.我创建了一个具有特殊ID的代码(有效,是的&#xff01;),但是我无法对其进行解密…您能帮我吗&#xff1f;这是我创建特殊ID的功能&#xff1a;Recovery_Script.phpinclude "…

php 图片系统,Linger

软件简介Linger 是 PHP 图片分享系统。一个精简的图片分享系统网站&#xff0c;采用Bootstrap前端框架&#xff0c;支持部分页面的移动端自适应。同时采用HTML5进行图片批量上传。使用了一个简单的时间线动态展示&#xff0c;可作为简易的图片社交社区。有一个完整的用户中心和…

php 传递类名,php 对象和数组序列化 serialize()返回字符串方便存储和传递 unserialize()反序列化 不丢失类型和结构...

现在开发中经常使用序列号和反序列化技术手段&#xff0c;php开发中也大量使用到。如下几个知名系统都使用了大量的序列化技术ecshop2. phpcms内容管理系统3.laravel框架一、序列号的目的&#xff1f;方便数组和对象的传输或存储&#xff0c;同时不丢失其类型和结构如下是ecsho…

基本的排序算法php,php四种基础排序算法

原标题&#xff1a;php四种基础排序算法曾经有网友问我关于面试题的问题&#xff0c;今天就发一个面试题笔试经常会出的排序算法&#xff0c;大家可以参考一下&#xff0c;如有问题可以给我留言。/*** php四种基础排序算法的运行时间比较* authors Jesse (jesse152163.com)* da…

php io流 读取wav,记php中的io流---帮助理解

//注意&#xff1a;当读到文件末尾的时候会返回-1.正常情况下是不会返回-1的。public static void main(String[] args) throws IOException {File fnew File("aaa.txt"); //定位文件位置InputStream innew FileInputStream(f); //创建字节输入流连接到文件byte[] bn…

php获取jsp的session的值,在JSP或Servlet中获取session数量

enumsul.getUserList();int i0;while(enums.hasMoreElements()){out.println(enums.nextElement());out.println(" ");if(i10){out.println("");}}out.println("当前在线的用户数&#xff1a;"i);out.println("退出登录");out.clos…

php如何查看上传的文件大小,PHP设置最大上传文件大小

一、修改php.ini文件。找到php中的php.ini文件&#xff0c;用写字板打开&#xff1a;1、查找post_max_size&#xff0c;指通过表单POST给PHP的所能接收的最大值&#xff0c;包括表单里的所有值&#xff0c;默认为8M&#xff0c;看你自己需要进行改变。2、查找File Uploads&…

java xy,java – 某个z深度的xy位置

我强烈建议你研究一些线性代数或矩阵数学用于3d图形.它既有趣又简单,但比SO答案要长一点.我会尝试:)免责声明&#xff1a;我不知道你正在使用的API&#xff01;看起来你正在为一个位置返回3个坐标(通常称为顶点).但是你也提到了一个投影矩阵,该函数有4个坐标.通常,着色器或API将…

django mysql 游标,MySQL Cursor 存储过程之游标与相关循环

简单介绍游标在检索出来的行中&#xff0c;前进或者后退一行或多行&#xff0c;就需要用到所谓的“游标”。游标不是某个SELECT语句&#xff0c;但是它是被该语句检索出来的结果集。几个特点&#xff1a;MySQL游标只能用于存储过程(和函数)。游标是不能滚动的&#xff0c;也就是…

java 8 optional 类,Java8新特性-Optional类

Optional 类(java.util.Optional) 是一个容器类&#xff0c;代表一个值存在或不存在&#xff0c;原来用 null 表示一个值不存在&#xff0c;现在 Optional 可以更好的表达这个概念。并且可以避免空指针异常。常用方法&#xff1a;Optional.of(T t) : 创建一个 Optional 实例Opt…

java 进度条jsp,jsp进度条_jsp技巧

开始页面:start.jsp状态页面:status.jspJSP进度条setTimeout(“locationstatus.jsp”, 1000);JSP进度条结果: %CELLPADDING0 CELLSPACING2> percent; i - 10) { %> 正在执行完成尚未开始已停止停止页面:stop.jsp业务逻辑bean:TaskBean.javapackage progress;import java.…