是否可以在文档文本中引用函数参数?
Is is possible to reference function's parameter in the documention text?
我想在文档文本中引用方法的参数,
但不知道该怎么做。
在 .NET 世界中,我们使用标签 paramref
举个例子:
/** Send email with the specified @paramref body to the addesses given in @paramref to.
@param body Just a plain text or teamplate-aware text.*/
def SendEmail(body: EmailBody, to: EmailAddress*) = ???
Scala 是如何实现的?
我认为您应该在 https://docs.scala-lang.org/style/scaladoc.html 中找到您需要的一切。对 "param name".
进行字符串搜索
您可以像Javadoc
一样在Scaladoc
中进行引用。根据the documentation for javadocs:
{@code foo}
和
<code>foo</code>
但是 XML
看起来很丑且不可读,更喜欢使用 {@code foo}
代替。
我想在文档文本中引用方法的参数,
但不知道该怎么做。
在 .NET 世界中,我们使用标签 paramref
举个例子:
/** Send email with the specified @paramref body to the addesses given in @paramref to.
@param body Just a plain text or teamplate-aware text.*/
def SendEmail(body: EmailBody, to: EmailAddress*) = ???
Scala 是如何实现的?
我认为您应该在 https://docs.scala-lang.org/style/scaladoc.html 中找到您需要的一切。对 "param name".
进行字符串搜索您可以像Javadoc
一样在Scaladoc
中进行引用。根据the documentation for javadocs:
{@code foo}
和
<code>foo</code>
但是 XML
看起来很丑且不可读,更喜欢使用 {@code foo}
代替。