scala - 如何使用@See scaladoc?

标签 scala scaladoc

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

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

最佳答案

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

关于scala - 如何使用@See scaladoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/53850885/

相关文章:

scala - 如何将 HashMap 转换为 Scala 中的子类?

Scaladoc [用例]

sbt - 使用doc任务生成scaladoc后如何运行bash脚本?

scala - 如何在doc任务中排除java源文件?

scala - 如何在 Maven 中包含 ScalaDoc 选项

mysql - 在 scala 中编写脚本以连接两个 mysql 表并创建一个对象(quill)

scala - List[EitherT[Future, A, B]] 到 EitherT[Future, A, List[B]] 与猫

scala - Play 2.3.8 的多个 SLF4J 绑定(bind)

Scaladoc 在 IntelliJ 中的右侧边缘换行

sockets - 通过 Akka IO 和套接字的 Protocol Buffer 消息