android-studio - 为 Android Studio 中的方法生成 KDoc-6ren

android-studio - 为 Android Studio 中的方法生成 KDoc

转载作者：IT老高更新时间：2023-10-28 13:32:31

28

4

在 Android Studio 中为 Java 注释方法时，我可以输入/**，AS 会为我生成带有方法参数和返回类型的 javadoc。但它似乎不适用于 Kotlin。

有没有办法教 AS 自动生成 Kotlin KDoc 格式的方法文档？

编辑:是的，这个问题与可能的重复问题大致相同，但我的问题不是“为什么？”，我知道 KDoc 有不同的格式。我的问题是是否有办法在 AS 中为 Kotlin 做同样的事情？也许有一种方法可以添加/编辑此模板或类似的东西？

最佳答案

自 2019 年 1 月起，Jetbrains 网站上有一个名为 kdoc-generator 的插件。

https://plugins.jetbrains.com/plugin/10389-kdoc-generator

Plugin to generate class and method KDoc.

此生成器的功能与 JavaDoc 完全相同。这意味着，当您使用“/**”创建注释并按 Enter 键时，kdoc 生成器会自动为参数创建“@param”或“@return”标签，并直接在此创建的注释下方创建方法的返回值。

当你输入 /**在您编写的方法上方的文件中，然后按回车键，您会得到类似以下内容:

/**
 *
 * @param str 
 * @param age
 */
fun foo(str: String, age: Int) {

}

直接在 Android Studio 中安装此插件:

打开文件/设置(Mac:AndroidStudio/Preferences)
选择插件
单击浏览存储库...
在搜索栏中输入“kdoc-generator”
点击安装
重启 Android Studio现在kdoc-generator已经安装好了，可以直接使用了。

此外，Jetbrains 还为 Kotlin 开发了一个文档引擎，您可以使用该引擎将 Kotlin 文件中的文档转换为一些标准格式，例如HTML

https://github.com/Kotlin/dokka

Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java. Just like Kotlin itself, Dokka fully supports mixed-language Java/Kotlin projects. It understands standard Javadoc comments in Java files and KDoc comments in Kotlin files, and can generate documentation in multiple formats including standard Javadoc, HTML and Markdown.

关于android-studio - 为 Android Studio 中的方法生成 KDoc，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/40574195/

28

4

0

文章推荐： node.js - 链接 Mongoose 查询的最佳方式

文章推荐： javascript - 使用 Mongoose 在 Node JS 中进行全文搜索

文章推荐： kotlin - Kotlin 是否支持一元理解？

Ruby 方法() 方法
我想了解 Ruby 方法 methods() 是如何工作的。我尝试使用“ruby 方法”在 Google 上搜索，但这不是我需要的。我也看过 ruby-doc.org，但我没有找到这种方法。
VBS教程：方法-Test 方法
Test 方法对指定的字符串执行一个正则表达式搜索，并返回一个 Boolean 值指示是否找到匹配的模式。 object.Test(string) 参数 object 必选项。总是一个
VBS教程：方法-Replace 方法
Replace 方法替换在正则表达式查找中找到的文本。 object.Replace(string1, string2) 参数 object 必选项。总是一个 RegExp 对象的名称。
VBS教程：方法-Raise 方法
Raise 方法生成运行时错误 object.Raise(number, source, description, helpfile, helpcontext) 参数 object 应为
VBS教程：方法-Execute 方法
Execute 方法对指定的字符串执行正则表达式搜索。 object.Execute(string) 参数 object 必选项。总是一个 RegExp 对象的名称。 string
VBS教程：方法-Clear 方法
Clear 方法清除 Err 对象的所有属性设置。 object.Clear object 应为 Err 对象的名称。说明在错误处理后，使用 Clear 显式地清除 Err 对象。此
VBS教程：方法-CopyFile 方法
CopyFile 方法将一个或多个文件从某位置复制到另一位置。 object.CopyFile source, destination[, overwrite] 参数 object 必选
VBS教程：方法-Copy 方法
Copy 方法将指定的文件或文件夹从某位置复制到另一位置。 object.Copy destination[, overwrite] 参数 object 必选项。应为 File 或 F
VBS教程：方法-Close 方法
Close 方法关闭打开的 TextStream 文件。 object.Close object 应为 TextStream 对象的名称。说明下面例子举例说明如何使用 Close 方
VBS教程：方法-BuildPath 方法
BuildPath 方法向现有路径后添加名称。 object.BuildPath(path, name) 参数 object 必选项。应为 FileSystemObject 对象的名称
VBS教程：方法-GetFolder 方法
GetFolder 方法返回与指定的路径中某文件夹相应的 Folder 对象。 object.GetFolder(folderspec) 参数 object 必选项。应为 FileSy
VBS教程：方法-GetFileName 方法
GetFileName 方法返回指定路径（不是指定驱动器路径部分）的最后一个文件或文件夹。 object.GetFileName(pathspec) 参数 object 必选项。应为
VBS教程：方法-GetFile 方法
GetFile 方法返回与指定路径中某文件相应的 File 对象。 object.GetFile(filespec) 参数 object 必选项。应为 FileSystemObject
VBS教程：方法-GetExtensionName 方法
GetExtensionName 方法返回字符串，该字符串包含路径最后一个组成部分的扩展名。 object.GetExtensionName(path) 参数 object 必选项。应
VBS教程：方法-GetDriveName 方法
GetDriveName 方法返回包含指定路径中驱动器名的字符串。 object.GetDriveName(path) 参数 object 必选项。应为 FileSystemObjec
VBS教程：方法-GetDrive 方法
GetDrive 方法返回与指定的路径中驱动器相对应的 Drive 对象。 object.GetDrive drivespec 参数 object 必选项。应为 FileSystemO
VBS教程：方法-GetBaseName 方法
GetBaseName 方法返回字符串，其中包含文件的基本名 (不带扩展名), 或者提供的路径说明中的文件夹。 object.GetBaseName(path) 参数 object 必
VBS教程：方法-GetAbsolutePathName 方法
GetAbsolutePathName 方法从提供的指定路径中返回完整且含义明确的路径。 object.GetAbsolutePathName(pathspec) 参数 object
VBS教程：方法-FolderExists 方法
FolderExists 方法如果指定的文件夹存在，则返回 True；否则返回 False。 object.FolderExists(folderspec) 参数 object 必选项
VBS教程：方法-FileExists 方法
FileExists 方法如果指定的文件存在返回 True；否则返回 False。 object.FileExists(filespec) 参数 object 必选项。应为 FileS

首页

博学

6Ren·AI

商城

android-studio - 为 Android Studio 中的方法生成 KDoc