如何让 dokka 在文档中不添加父类的函数
时间: 2024-02-27 18:51:52 浏览: 138
如果你想让 Dokka 在生成文档时不包含父类的函数,可以使用 Dokka 的 `@suppress` 标签。具体来说,你可以在子类中使用 `@suppress` 标签,将父类中的函数或属性标记为被抑制的元素,从而在文档中不显示它们。
下面是一个示例,假设你有一个父类 `BaseClass` 和一个子类 `DerivedClass`,你想在 `DerivedClass` 中隐藏 `BaseClass` 中的 `foo()` 函数:
```
open class BaseClass {
fun foo() {}
fun bar() {}
}
class DerivedClass : BaseClass() {
override fun bar() {}
/**
* @suppress
*/
override fun foo() {}
}
```
在上面的示例中,我们在 `DerivedClass` 中使用 `@suppress` 标签来抑制父类 `BaseClass` 中的 `foo()` 函数,从而在生成的文档中不显示该函数。注意,我们还需要在子类中重新实现 `bar()` 函数,因为我们抑制了父类中的 `foo()` 函数,这使得我们必须要提供一个新的实现,否则子类就会成为抽象类。
相关问题
dokka 如何设置 visibility
在 Dokka 中,你可以使用 `@since` 标签来设置文档元素的可见性。`@since` 标签可以接受一个可见性修饰符作为参数,例如 `public`、`protected`、`private` 或 `internal`,这样可以控制文档元素的可见性。
下面是一个示例,假设你有一个类 `MyClass`,你想将其设置为 `internal` 可见性:
```
/**
* @since internal
*/
class MyClass {
// ...
}
```
在上面的示例中,我们在类的文档注释中使用 `@since` 标签来设置类的可见性为 `internal`。这样,在生成的文档中,Dokka 就会将该类标记为 `internal`。
除了 `@since` 标签外,你还可以使用其他一些标签来设置文档元素的可见性,例如 `@public`、`@protected` 和 `@private`。这些标签与 `@since` 标签的作用相同,只不过更加明确。
IntelliJ IDEA新建项目页中没有显示AI
IntelliJ IDEA是一款流行的集成开发环境(IDE),它通常用于Java和其他多种语言的开发。当你打开新项目页面(通常被称为"欢迎界面"或"New Project Wizard")时,如果没有直接看到与AI相关的模板或者配置选项,那可能是因为默认设置里没有包含AI项目的模板。
1. AI相关的功能可能需要特定插件支持,比如JetBrains自家的Dokka插件用于文档生成,如果涉及到AI开发,可能会有第三方插件如Maven或Gradle库管理插件来处理机器学习库的依赖。
2. 如果你想创建一个包含AI元素的项目,例如基于深度学习或自然语言处理,可能需要手动选择合适的项目结构,然后自行添加相关的库、框架(如TensorFlow、PyTorch等)。
3. 确保已经安装了必要的SDK或框架支持,你可以在插件市场搜索相关的AI工具,并按照引导进行安装。
阅读全文