JavaDoc学习笔记

官方学习文档

• How to Write Doc Comments for the Javadoc Tool

常用的HTML标签

---

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

加粗 strong

<strong>Strong</strong>

超链接 href

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

换行

/** <p>
*
**/

图片引用

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

常用的格式

---

标题加粗换行

 /**
 * <dl>
 *  <dt><b>Backpressure:</b></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><b>Scheduler:</b></dt>
 *  <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd>
 * </dl>
 **/