首页 > 代码库 > java 注释文档使用

java 注释文档使用

我们经常使用的第三方jar包,jdk等都有自己的源码注释文档,自己开发时的java代码最好也是有注释文档较好,便于理解和维护。


1. 文档语法

  

语法

举例

说明

{@link 地址}

{@link java.nio.charset.CharsetDecoder}

点击跳转到相应类的注释文档

{@link 地址#方法或属性 别名}

{@link  CharSequence#length()  length}

因为注释类与CharSequence在同一个包下,所以可以忽略包名,如果链接的方法就是自己的方法,则类名也可忽略

{@linkplain 地址 别名}

{@linkplain  java.nio.charset.Charset

 charset}

点击charset,转到相应类的注释文档

<br>

 

换行

<p>

 

分段

{@code 代码}

{@code true}

表示java代码true

  另外可以参考 http://baike.baidu.com/item/javadoc?fr=aladdin

2.

 

java 注释文档使用