Intellij idea 生成Kotlin方法/类注释
如何为方法/类生成注释?只需键入:Intellij idea 生成Kotlin方法/类注释,intellij-idea,comments,kotlin,Intellij Idea,Comments,Kotlin,如何为方法/类生成注释?只需键入: /** 在IntelliJ IDEA 2016.1.3中,按enter键似乎不起作用 看起来Dokka已经取代了KDoc,但为什么IntelliJ中没有支持?还是我遗漏了什么 澄清:键入/**+enter时,将生成: /** * */ 但我想知道为什么没有添加@param和其他的生成(就像IntelliJ为Java所做的那样)。这些注释也用于记录Kotlin代码()未生成@param和其他标记,因为Kotlin的推荐文档样式是使用[foo]语法引用文档
/**
在IntelliJ IDEA 2016.1.3中,按enter键似乎不起作用
看起来Dokka已经取代了KDoc,但为什么IntelliJ中没有支持?还是我遗漏了什么
澄清:键入/**+enter时,将生成:
/**
*
*/
但我想知道为什么没有添加@param和其他的生成(就像IntelliJ为Java所做的那样)。这些注释也用于记录Kotlin代码()未生成
@param
和其他标记,因为Kotlin的推荐文档样式是使用[foo]
语法引用文档注释文本中的参数名称,而不是使用显式@param
标记记录它们。您可以查看查看此样式的使用方式。要详细介绍@yole的答案和@Charles A.的评论,以下是创建KDocs时首选格式的完整说明,以及它与JavaDocs的区别
Kotlin文档如下:
…说:
通常,避免使用@param和@return标记。相反,将参数和返回值的描述直接合并到文档注释中,并在提到参数的地方添加指向参数的链接。仅当需要较长的描述,而该描述不适合正文的流程时,才使用@param和@return
避免这样做:
/**
* Returns the absolute value of the given number.
* @param number The number to return the absolute value for.
* @return The absolute value.
*/
fun abs(number: Int) = ...
改为这样做:
/**
* Returns the absolute value of the given [number].
*/
fun abs(number: Int) = ...
/
+*
+*
+输入
在2016.1.3为我生成/***\n*\n*/
。您是否有导致问题的插件?您好,是的,对不起,我应该澄清一下,它确实生成了这些问题,但它没有生成@params/@return,记录在这里:编辑:为问题添加了澄清。可能重复,那么为什么页面上有所有可用标记的列表?我真的遗漏了什么吗?这些标签是可用的,受支持的,但不推荐使用。我必须请您将我链接到尽可能详细地描述文档过程的文档。谢谢因为从我在上一篇评论中发布的链接的外观来看,我觉得这就是Kotlin官方文档建议使用的内容。@Daksh为了它的价值,我找到了正在引用的文档。“foo”是什么意思?