gpt4 book ai didi

scala - 在 Scaladoc 中添加代码示例

转载 作者:行者123 更新时间:2023-12-04 22:04:12 26 4
gpt4 key购买 nike

在 ScalaDoc 中添加代码示例的标准约定(或标记)是什么?下面代码中的示例,我想提供编码示例来演示它的用法:

/**
* Adds a filter on DB Table Query if value is defined. Example:
*
* {code}
* val startIncluded: Option[Timestamp] = _
* tableQuery.filter(startIncluded)(startTime => _.start >= startTime)
* {code}
*
* ... other doc ...
*/
def filter (value: Option[T])(condition: T => Table => Option[Boolean]) = {

就像在 javadocs 中一样,使用了 @code

最佳答案

您可以使用 {{{ }}} to delimit code blocks :

/**
* This is a comment.
*
* {{{
* this.is(example.code)
* }}}
*/
def is(some: Code): Unit

关于scala - 在 Scaladoc 中添加代码示例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32317581/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com