如何在IntelliJ中强制文档

问题描述 投票:1回答:1

回到我以前使用Java和Eclipse时,创建一个新方法会自动在它的顶部添加一个Javadoc注释。这导致我记录的内容远远超过目前的记录。

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

scala intellij-idea documentation
1个回答
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)

现在您可以完成文档。

© www.soinside.com 2019 - 2024. All rights reserved.