163得票9回答
如何在Kotlin KDoc中使用@link和@code

我正在尝试记录一种方法,并尝试使用 @link 和 @code,就像在JavaDoc中一样。 我知道在Kotlin中有一个kDoc,但我找不到它们或至少类似的东西。

53得票1回答
KDoc:插入代码片段

如何在 Kotlin 的默认文档工具 KDoc 中插入代码片段? 在 Java 中,我可以使用以下代码:/** * Example usage: * * <pre> * <code>@JavaAnnotation * public void ...

32得票1回答
如何继承KDoc文档?

在Java的Javadoc中,有一种方法可以使用{@inheritDoc}标签,在子类中继承一个方法的文档。 在Kotlin的KDoc中是否有同样的方法呢? 基本上,我想做的是以下内容:abstract class Base { /** * Some KDoc docum...

32得票3回答
KDoc中的换行和新行是怎样的呢?

假设我们有这样的记录字符串。/** retrieve a state of the service * <br/> HTTP code 200 - normal state * <br/> HTTP code 403 - some recoverable state: ...

27得票1回答
如何在Kotlin数据类中记录属性?

在Kotlin数据类的KDoc中,我应该把属性的Javadoc类比放在哪里? 换句话说,如何在Kotlin KDoc中编写以下Java代码的Javadoc: /** * Represents a person. */ public class Person { /** ...

27得票1回答
如何在KDoc中表示超链接

在Javadoc中,我可以使用@see <a href="http://google.com">http://google.com</a>表示超链接。在Kotlin中如何实现?

22得票1回答
如何在Kotlin文档(KDoc)中添加格式,例如加粗、斜体、下划线等。

我在官方Kotlin参考文档中找到了《Kotlin代码文档化》页面。 然而,我无法找到如何突出文档的特定部分,例如将其标记为斜体或粗体。 我是一名来自Java的新手,之前只使用过JavaDoc,在那里我们使用<i>和<b> HTML标签来突出文档中的部分。

19得票1回答
在Kotlin文档(KDoc)中,是否可以链接到特定的重载方法?

考虑这个Kotlin类的类注释:/** * This class has two methods, one that takes one parameters ([foo]), * and another one that takes two parameters ([foo]). **...

16得票1回答
我能否引用特定的函数重载?

考虑以下代码fun example() {} fun example(name: String) {} 我该如何引用特定函数?例如 example() 或者 example(String)? 使用 [example] 无法明确指定我想要的具体函数。

13得票1回答
你应该如何为 Kotlin 包添加文档?

在Java中,如果您想记录一个包(package),它必须被放置在package-info.class文件中。在Kotlin和KDoc中是否仍然是同样的情况? 我查看了一些Kotlin源代码,找不到他们的包(package)文档写在哪里。