scala - 如何使用@See scaladoc？

Question

使用 @See scaladoc 的确切语法是什么？如何引用:

• 同一个类中的方法
• 另一个类(class)
• “http”引用

？

Answer 1

语法与 scaladoc 的任何其他部分相同。您基本上添加 @see 符号，然后编写描述引用的纯文本。示例:

• @see [[方法]]
• @see [[YourCurrentClass.method]]
• @see [[您当前的类(class)]]
• @see 请参阅 [[scala.concurrent.Future]] 了解更多
• @see 请参阅 [[http://example.com 完整文档]] 了解 ABC 的可能值

编辑:

@see 的官方文档:https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#usage-tags

一般引用文献的官方文档:https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#markup