2017-08-25 71 views
2

我很想在文档文本 中引用方法的参数,但不知道如何去做。
在.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*) = ??? 

它是如何在斯卡拉做了什么?

回答

2

Javadoc类似,您可以参考Scaladoc。据the documentation for javadocs

{@code foo} 

<code>foo</code> 

XML长相丑陋而无法读取,更喜欢使用{@code foo}代替。