Java Doc和Kotlin常用注释总结

Java Doc注释

@see：必须顶头写， 标签允许用户引用其他类的文档。具体使用方式如下：

    @see classname
    @see fully-qualified-classname
    @see fully-qualified-classname#方法名称
    @see fully-qualified-classname#属性名称

语法格式： @see 全路径包名#方法名(参数类型列表)

例子

/**
 * 
 * @see com.sjl.activity.LoginActivity#login(String, String)
 */
public void test() {
    
}

@link：任意位置写

语法格式：{@link 全路径包名#方法名(参数类型列表)}

例子1

 @deprecated Use {@link LoginActivity#login(String, String)} directly

例子2

/**
 *
 * 
 * {@link com.sjl.activity.LoginActivity#login(String, String)}
 * 
 */
public void test() {
    
}

@code： {@code text} 将文本标记为code

{@code text} 会被解析成 text
将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式

一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

详细描述一般用一段或者几个锻落来详细描述类的作用，详细描述中可以使用html标签，如

、

、、
、等标签， 通常详细描述都以段落p标签开始。
 详细描述和概要描述中间通常有一个空行来分割
 
 
Kotlin Doc注释（KDoc）
 
 
使用markdown语法
 
 
参考：https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier
 
 
区别
 
 
 
  
链接方式：链接引用代码
 
 
 
 
Java
 
 
 /**
 *
 * 
 * {@link com.sjl.activity.LoginActivity#login(String, String)}
 * 
 */
public void test() {
    
}
 
 
Kotlin
 
 
/**
 *
 * 
 * 
 * [这是一个链接][com.sjl.activity.LoginActivity.login]
 * 
 */
fun test() {
    
}   
 
 
 
  
超链接
 
 
 
 
Java
 
 
 /**
  * @see 描述链接的文字
  */
 
 
Kotlin
 
 
 /**
  * [描述链接的文字](https://blog.csdn.net/u011082160?type=blog)
  */
 
 
 
  
代码引用
 
 
 
 
Java
 
 
 /**
  * {@code java}
  */
 
 
**Kotlin **
 
 
 /**
  * `Kotlin`
  */