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

Question

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

这是我所看到的示例:

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

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

Answer 1

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

像这样的注释 block 意味着您有很长的方法，可以做太多的事情，并且每个小节都需要解释它到底在做什么。

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

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

createAndLoadWorld(...);

或者

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

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