如何使用@See scaladoc？

Question

使用@Seescaladoc 的确切语法是什么？我如何参考：

• 同一类中的方法
• 另一堂课
• “ http”参考

？

Answer 1

语法与scaladoc的任何其他部分相同。基本上@see，您可以添加表示法，然后编写描述参考的纯文本。例子：

• @see [[method]]
• @see [[YourCurrentClass.method]]
• @see [[YourCurrentClass]]
• @see See [[scala.concurrent.Future]] for more
• @see See [[http://example.com the full documentation]] on possible values of 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