什么是在javadoc注释中插入标记代码的IntelliJ快捷键?

时间:2016-09-06 10:48:57

标签: java intellij-idea javadoc

我想在撰写评论时快速将文本格式化为代码。在Javadoc中,要将文本格式化为代码,您必须在{@code … }标记内包含文本。但是,输入大括号然后@和之后的文本有点单调乏味。如果有一个快捷键可以更快地实现它,那就太好了。

IntelliJ在javadoc注释中插入{@code .... }的最简单方法是什么?

2 个答案:

答案 0 :(得分:3)

创建一个新的环绕实时模板,其中包含您可以记住的缩写(例如S代码)。描述Surround with {@code ...}之类的内容。模板文字:{@code $SELECTION$}。适用于Java | Comment

现在,您可以使用{@code ...}选择要包围的任何文本并调用Code | Surround With... Ctrl + Alt + T 后跟你的缩写)来格式化它。

答案 1 :(得分:2)

我已经注意到已经有一个教程如何为项目生成JavaDoc参考,它告诉我:

  

生成项目文档

     
      
  1. 在主菜单上,选择“工具”|生成JavaDoc。生成JavaDoc   对话框已打开。
  2.   
  3. 在Generate JavaDoc对话框中,指定以下选项:      
        
    • 选择范围(整个项目或某个项目   带子包)。
    •   
    • 指定将放置生成的文档的输出目录。
    •   
    • 使用滑块定义要包含在生成的文档中的成员的可见性级别。
    •   
  4.   
  5. 指定其他JavaDoc选项。请参阅“生成”主题   JavaDoc对话框,用于描述控件。
  6.   
  7. 单击“确定”。
  8.         

    来自:https://www.jetbrains.com/help/idea/2016.2/generating-javadoc-reference-for-a-project.html

但在提到Generate JavaDoc Dialog时,没有提供{@code .... }范围...

  

IntelliJ在javadoc注释中插入{@code ....}的最简单方法是什么?

我认为最简单的方法是创建实时模板以供日后使用。

只需转到Settings -> Live Templates,选择Templates Group,创建JAVADOC模板组,然后添加您的JavaDoc code模板。

希望它会有所帮助