JavaDoc学习笔记

2019-11-14 10:08:08

字体：大中小

来源：转载

供稿：网友

官方学习文档

How to Write Doc Comments for the javadoc Tool

常用的HTML标签

标签	含义
`<strong></strong>`	字体加粗
`<p>`	换行
`<img src="" width="" height="">`	图片引用
`<a href=""></a>`	超链接内容

加粗 strong

Strong

超链接 href

<a href="http://go.microsoft.com/fwlink/?LinkID=205219">Rx Design Guidelines (PDF)</a>

换行

/** ***/

图片引用

<img width="640" height="200" src="https://raw.github.com/create.png" alt="">

常用的格式

标题加粗换行

/** * <dl> * <dt>BackPRessure:</dt> * <dd>The {@code OnSubscribe} instance provided is responsible to be backpressure-aware or * document the fact that the consumer of the returned {@code Observable} has to apply one of * the {@code onBackpressureXXX} Operators.</dd> * <dt>Scheduler:</dt> * <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd> * </dl> **/

上一篇：node.js实战学习笔记03--使用闭包控制异步程序的状态

下一篇：求先序排列