【问题标题】:How to use @See scaladoc?如何使用@See scaladoc?
【发布时间】:2018-12-19 12:05:28
【问题描述】:

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

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

?

【问题讨论】:

    标签: scala scaladoc


    【解决方案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

    【讨论】:

    • @GamingFelix 这是 StackOverflow 明确鼓励的事情,请参阅:stackoverflow.blog/2011/07/01/…
    • 也蛮好用的。例如,我的一个 QA-s 获得了大约 50 个赞、15 个书签和 25k 次浏览——希望对人们有用。如果他们从搜索中弹出,我有时也会喜欢其他人的 QA。
    • 好吧,很公平。似乎是一个非常简单的问题,可以在文档中找到。 docs.scala-lang.org/style/scaladoc.html
    • @GamingFelix 更具体地说,docs.scala-lang.org/overviews/scaladoc/…
    • @VasyaNovikov 我猜你每天都会学到一些新东西。我以后会试试的。我还是 StackOverflow 的新手。我还建议您包括 James Whiteley 的答案。
    猜你喜欢
    • 2011-03-28
    • 2014-10-17
    • 2012-11-06
    • 1970-01-01
    • 2019-03-27
    • 1970-01-01
    • 2016-04-14
    • 2016-01-20
    • 2012-08-13
    相关资源
    最近更新 更多