将 KDoc 文档从一种方法复制到另一种方法

Posted 2023-04-14

【中文标题】将 KDoc 文档从一种方法复制到另一种方法

【英文标题】：Copy KDoc docs from one method to another

【发布时间】：2016-06-27 15:52:16

【问题描述】：

对于两个给定的方法：

/**
* Adds a [DataItem] to the android Wear network. The updated item is synchronized across all devices.
*/
fun putItem() .... 

/**
* "same KDOC here with above"
*/
fun putItem(putRequest: PutDataRequest) .... 

是否有可能复制/链接第二种方法的文档以与第一种方法相同？

手动复制粘贴 KDOC 并不是很好，因为如果您更新其中一个，第二个很可能会意外过时。

【问题讨论】：

可能没有。如果有办法，它可以用于继承 KDoc，但我的类似问题得到否定答案：***.com/questions/35776564/…

这可能会在youtrack.jetbrains.com 中提出一个很好的功能请求......虽然你确实有不同的参数所以不确定你会怎么说“和上面一样，加上一点额外的”

将putRequest 更改为可选参数可能是更好的设计。这样你就不会有任何重载，也不需要复制文档。

@yole 在我的例子中非常适合，谢谢。但也有方法名和结果相同但参数类型不同的情况。

【参考方案1】：

KDOC 目前没有这样的功能。

请向YouTrack提交功能请求。

reference guide for KDOC 显示可用的功能集。