Intellij IDEA中的花式代码注释

Question

当我认识到中心评论时，我正在浏览GitHub上的一个开发代码。起初我觉得有人觉得今天做了一个非常好看和花哨的评论，然后我意识到他们在整个项目中被使用了。

这是我见过的一个例子：

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

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

Answer 1

虽然它看起来不错，但我认为需要这样的评论才是代码味道。

这些评论块暗示你有很长的方法可以做太多的事情，每个小节都需要解释它正在做什么。

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

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

createAndLoadWorld(...);

或

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

现在，您可以更轻松地测试代码，因为您可以单独测试方法或模拟它们。