java - Intellij IDEA 中的花式代码注释

Question

当我认出居中评论时，我正在浏览 GitHub 上的开发人员代码。起初我以为有人今天想发表一个非常好的和花哨的评论，然后我意识到他们在整个项目中使用。

这是我看到的一个例子:

    /*
     * =============================================================
     * ================ WORLD CREATION AND LOADING =================
     * =============================================================
     */

我在开发聊天中四处询问，似乎没有人知道它来自哪里。有人可以告诉我是否可以将所有注释重新格式化为这样，或者可以将其添加为 IDE (IntelIj) 中的格式化程序。

Answer 1

虽然它看起来不错，但我认为需要这样的注释是一种代码味道。

像这样的评论 block 暗示你有很长的方法做太多的事情，每个小节都需要解释它到底在做什么。

我曾经重构过一个我继承的遗留项目，在那里我将所有看起来像这样的 block 注释转换成它们自己的方法。新方法的命名以一种源自原始评论的意图揭示的方式命名。这样，我可以添加更多解释性 javadoc 以更好地解释代码块中发生的事情。

例如，我会将这段代码重构为:

createAndLoadWorld(...);

或者

World world = create(....);
load(world);

现在您可以获得更容易测试代码的额外好处，因为您可以单独测试方法或模拟它们。