是否可以在文档文本中引用函数的参数?

时间:2017-08-25 10:47:47

标签: scala scaladoc

我想在文档文本中引用方法的参数,  但不知道怎么做。
在.NET世界中,我们使用标记paramref

仅作为一个例子:

@foreach($items as $item)
    <div class='item-title'>{{$item->title}}</div>
    <div class='item-description'>{{$item->description}}</div>
@endforeach

如何在Scala中完成?

2 个答案:

答案 0 :(得分:2)

您可以在Scaladoc中与Javadoc类似地进行参考。根据{{​​3}}:

{@code foo}

<code>foo</code>

但是XML看起来很难看,而且不易阅读,所以更喜欢使用{@code foo}

答案 1 :(得分:-2)

我认为您应该在https://docs.scala-lang.org/style/scaladoc.html中找到所需的一切。做一个字符串搜索&#34; param name&#34;。