如何在 IntelliJ 中强制文档

Question

当我使用 Java 和 Eclipse 时，创建一个新方法会自动在其顶部添加一个 Javadoc 注释。这导致我记录的内容比现在要多得多。

在使用 IntelliJ 进行 Scala 开发时，我没有获得相同的功能，这使得我编写的文档数量最终变得非常少。有没有办法将此功能添加到 IntelliJ？如果没有，我是否可以做类似的事情，例如 this question for Visual Studio（未找到文档时发出警告）。

Answer 1

支持此功能，但您需要请求生成 Scaladoc 块（也称为“docblock”）。例如，给定以下案例类：

case class Wallet(password: String, destinationDirectory: File, isFullWallet: Boolean=true)

您可以通过在案例类上方的行中键入/** 并按 Enter 来生成文档块。您现在应该看到：

/**
  * 
  * @param password
  * @param destinationDirectory
  * @param isFullWallet
  */
case class Wallet(password: String, destinationDirectory: File, isFullWallet: Boolean=true)

现在您可以完成文档了。