Intellij:将多行字符串格式化为Javadoc注释

时间:2016-11-08 16:24:39

标签: java intellij-idea

是否存在将多行字符串格式化为Javadoc注释的热键?

  

这是评论

     

我想将其格式化为评论

     

请格式化我

/**
 * This is a comment
 * I want to format it as a comment
 * Please format me
 */

cmd + /仅将其格式化为//评论

修改 不知道为什么这个没有评论或答案而被投票,但我会更新它:

我有1300行文件,其中包含许多字符串,所有字符串都是多行的。我需要使用这些多行字符串,其中没有一个是Javadoc注释,并使它们成为javadoc注释。我不想使用// 非常特别想要

形式的Java标准Javadoc评论
/**
 * 
 */

我试图避免超过1300行并手动添加注释字符串。

1 个答案:

答案 0 :(得分:0)

在IntelliJ IDEA中创建Javadoc的最简单方法是键入空心块注释/**,然后按 Enter 。其余代码将由IDEA生成。

Javadoc /**...*/与常规评论区块/*...*/的区别在于其中还包含一些其他信息,例如@param@return@see等一些标签,如{@link URL},用于通过运行Javadoc来创建HTML。

如果你想将一些现有的评论块转换为Javadoc,你可以这样做:

  1. 再添加一个星号*,使评论成为Javadoc。
  2. 将插入符号放在类,方法,函数或字段中的某个位置,应记录下来并按 Command + Shift + A 调用Find Action命令。
  3. 在输入字段中输入fix doc comment,然后按 Enter
  4. 将添加带有相应标签的缺失文档存根。
  5. 当您使用IDEA的快速修复建议更改方法签名时,您也可以通过这种方式修复Javadoc。

    希望这会对你有所帮助。阅读更多Creating Documentation Comments