未加星标

Java 9 series: HTML5 Javadoc

字体大小 | |
[前端(javascript) 所属分类 前端(javascript) | 发布者 店小二03 | 时间 2016 | 作者 红领巾 ] 0人收藏点击收藏

This is the forthin a series of articles looking at some of the JDK Enhancement Proposals (JEPS) hoping to make their way into Java 9. Last week we looked atchanges to the JVM.

This week we’re looking at less exciting JEP, but important for accessibility: JEP 224: html5 Javadoc .

HTML5 Javadoc

Javadoc is a tool for generating API documentation. It generates the documentation in HTML format. JEP 224 enhances the javadoc tool to generate HTML5 markup.Itcurrently generates pages in HTML 4.01 .

The easiest way to learn about javadoc and experiencethe benefits to your documentation is to use it. Download theJava 9 Early Access Release. You can check the Javadoc version is “9” by running:

javadoc -J-version

java version "9-ea"
Java(TM) SE Runtime Environment (build 9-ea+138)
Java HotSpot(TM) 64-Bit Server VM (build 9-ea+138, mixed mode)

Looking at the example code from Just enough code: Mutation Testing , we can add comments to the class to convey moreinformation about what the code is doing:


Java 9 series: HTML5 Javadoc

This project is using the Java 9 Early Access Release as its SDK. If you are using an IDE such as IntelliJ IDEA, you canuse the “Tools” / “Generate Javadoc …” option to create the Javadoc.


Java 9 series: HTML5 Javadoc

In order to generate a HTML5 Javadoc, the parameter -html5 needs to go in the command line arguments.

To generate the documenton the command line, you would run:

javadoc [options] [packagenames] [sourcefiles] [@files]

For information on how to do this, see earlier Javadoc documentation .

You can specify the output for the documentation files.Here I’ve lazily added an extra folder:
Java 9 series: HTML5 Javadoc
Then you can view the results:
Java 9 series: HTML5 Javadoc

Going into the AccountTypeCalculator, we can see the method details generated from the comments:


Java 9 series: HTML5 Javadoc
HTML5

Using HTML5 in Javadocs confers the benefits of the easier HTML5 structure. Italso implements the WAI-ARIA standard for accessibility. This aims to make it easier for people with physical or visual impairments to access pages using tools such as screen readers. Sites such as HTML5Accessibility track which HTML5 features are accessibly supported by major browsers: meaning, available for use by people who rely on assistive technologies.

For more information on using the Javadoc tool, see the Oracle guide here .

本文前端(javascript)相关术语:javascript是什么意思 javascript下载 javascript权威指南 javascript基础教程 javascript 正则表达式 javascript设计模式 javascript高级程序设计 精通javascript javascript教程

主题: JavaHTMLHTML5RIAJVM
分页:12
转载请注明
本文标题:Java 9 series: HTML5 Javadoc
本站链接:http://www.codesec.net/view/485620.html
分享请点击:


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 前端(javascript) | 评论(0) | 阅读(22)