如何在IntelliJ中强制文档

时间:2017-12-17 10:44:17

标签: scala intellij-idea documentation

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

当使用IntelliJ进行Scala开发时,我没有得到相同的功能,这使得我写的文档数量最终变得非常小。有没有办法将此功能添加到IntelliJ?如果没有,是否有类似我可以做的事情,例如在Visual Studio的this question中(当没有找到文档时发出警告)。

1 个答案:

答案 0 :(得分:0)

支持此功能,但您需要请求生成Scaladoc块(也称为“docblock”)。例如,给出以下案例类:

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

您可以通过在案例类上方的行上键入/**并按Enter键来生成docblock。你现在应该看到:

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

现在您可以完成文档。