简而言之,RUST编译器可以根据实际代码在注释中编译某些代码,例如示例代码,从而生成始终最新的注释.

有谁知道Kotlin或Java Code有什么类似功能吗? 有什么建议吗?

我好不容易才在谷歌上搜索到它.

我渴望的基本上是:

/**
 * some descriptive text
 * 
 * Example:
 * ```
 * val foo = bar();
 * assert(foo == "bar"); 
 * ```
 *
 * @return "bar" as String
**/
fun bar() = "bar";

就像自动化测试一样,当BAR更改其返回值时,该示例应该失败.否则,将作为示例代码成为文档的一部分.

推荐答案

我刚刚发现的一种方法是使用KDoc @sample tag构建关联的样例代码,然后将其嵌入到Dokka生成的文档中.

我找到了this article which elaborates on that approach个,也指出了一些缺点,比如渲染效果不佳.但在这个方向上,这无疑是一个良好的开端.

Kotlin相关问答推荐

创建具有共同父类型的两种不同类型对象的列表的最有效方法是什么?

UByte范围. Min_UTE.. UByte.MAX_UTE不符合预期

Kotlin是否针对范围和进度优化sum()?

处理合成层次 struct 中的深层按钮以切换视图

如何在 Kotlin 中初始化 Short 数组?

可以在没有导入声明的情况下调用 Kotlin 扩展函数吗?

jlink:在合并模块和 kotlin.stdlib 中打包 kotlin.*

将 Integer 转换为 Unit 编译成功

为 Gradle 子项目配置 Kotlin 扩展

多次运行espresso测试

具有多个不同类型来源的 LiveData

判断 AAR 元数据值时发现的一个或多个问题:

runBlocking 中的 deferred.await() 抛出的异常即使在被捕获后也被视为未处理

如何解决:将Java类转换为Kotlin后出现error: cannot find symbol class ...?

如何为kotlin异常生成SerialVersionId?

Android EditText 协程go 抖操作符,如 RxJava

重复构建失败To use Coroutine features, you must add `ktx`......

在 kotlin 中,如何将主构造函数中的属性设置器设为私有?

将字符串编码为Kotlin中的UTF-8

项目不会使用 Kotlin 1.1.3 构建