Необычный код Комментарии в Intellij IDEA

Question

Я просматривал код разработчика на GitHub, когда узнал комментарии по центру. Сначала я думал, что кто-то хотел сделать действительно хороший и модный комментарий сегодня, затем я понял, что они использовались во всем проекте.

Вот пример того, что я видел:

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

Я спросил в чате разработчиков, и никто, казалось, не знал, откуда он взялся. Может кто-нибудь сказать мне, если возможно переформатировать все комментарии, чтобы выглядеть так, или, возможно, добавить его в качестве средства форматирования в IDE (IntelIj).

Answer 1

Несмотря на то, что это выглядит красиво, я думаю, что такой комментарий - это запах кода.

Блоки комментариев, подобные этим, подразумевают, что у вас есть очень длинные методы, которые делают слишком много вещей, и каждый подраздел нуждается в объяснении, какого черта он делает.

Однажды я провел рефакторинг унаследованного проекта, который унаследовал, где я преобразовал все комментарии блока, которые выглядели так, в свои собственные методы. Новые методы были названы с намерением раскрытия, основанного на оригинальном комментарии. Таким образом, я мог бы добавить больше пояснений к javadoc, чтобы лучше объяснить, что происходит в блоке кода.

Например, я бы взял этот код и реорганизовал бы его либо в:

createAndLoadWorld(...);

Или же

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

Теперь вы получаете дополнительное преимущество, заключающееся в упрощении тестирования кода, поскольку вы можете тестировать методы изолированно или макетировать их.