Kotlin的文档注释

一、前言

在编写程序时候，有时候需要编写注释，对于一个代码的说明有时候会需要对其它代码进行关联。使点击关键词即可查看相关代码。不过文档注释功能不属于Android提供，属于由各自的语言提供，java文档注释和kotlin文档注释不同。另外kotlin文档支持markDown语法。可以在注释里面插入markdown风格注释

二、@link 和[]

在java文档中 使用@link 可以链接到相应的代码
在kotlin里面需要使用 []
如下

   /**
     * 添加基础聊天布局
     * 如果直接重写该函数，而不重写[View] 函数时候，则不会添加到父布局
     * @param view
     * @return
     */

在kotlin中可以将以上代码复制进去进行尝试

三、参考文档

1. Document Kotlin code: KDoc and Dokka
   https://kotlinlang.org/docs/kotlin-doc.html

2. Java文档注释
   https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/doc-comment-spec.html

3. JavaDoc 指南
   https://docs.oracle.com/en/java/javase/16/javadoc/javadoc.html#GUID-7A344353-3BBF-45C4-8B28-15025DDCC643

4. Java文档
   https://docs.oracle.com/en/java/javase/16/

5. MarkDown语法
   https://daringfireball.net/projects/markdown/syntax