【问题标题】:What's the different types of comments in IntelliJ IDEA? [duplicate]IntelliJ IDEA 中有哪些不同类型的注释? [复制]
【发布时间】:2016-10-10 10:16:18
【问题描述】:

在我使用 Eclipse 之前,我昨天开始使用 IntelliJ IDEA 进行 java 编程。

我注意到这个软件使用了两种类型的 cmets(不包括经典的//comment here):

  • /* comment here */ 会显示为灰色
  • /** comment here */ 会显示为绿色

这两者有什么区别?我应该什么时候用一个,什么时候用另一个?

【问题讨论】:

  • 第一个是多行注释,第二个是文档注释。
  • 我应该什么时候使用一个,什么时候使用另一个?

标签: java intellij-idea


【解决方案1】:
/*.....*/

如果要注释掉多行,则需要使用多行注释。

如果您想为您的方法/变量提供适当的文档,您需要使用文档 cmets。由于 jdk 附带了一个工具,它将为您的类创建一个文档。

/**
* This method is used to ...
*/
e.g  public void method()
{
//your logic
}

你也可以将它用于变量。

/**
* This variable is used for ...
*/
private static int s=99;

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-02-13
    • 2021-08-12
    • 2018-06-09
    • 2017-10-07
    • 2020-08-26
    • 1970-01-01
    相关资源
    最近更新 更多