如何使用@See scaladoc?

时间:2018-12-19 12:05:28

标签: scala scaladoc

使用@See scaladoc的确切语法是什么?我该如何参考:

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

1 个答案:

答案 0 :(得分:5)

语法与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