Разделение кода с комментариями для чтения. Хорошая или плохая идея?

Question

Так что я недавно начал программировать, и иногда я чувствую к необходимости разделить мой код с комментариями блоков, как это:

//=============================================================================== 
//Constructors 
//=============================================================================== 

*constructors* 

//=============================================================================== 
//End of Constructors 
//=============================================================================== 

Например, я мог бы иметь раздел «Конструктор» и раздел «Getter/сеттер», или «Ok Button Implementation» со всей конфигурацией кнопки OK, нажмите прослушиватели и т. д. Это позволяет мне быстро прокручивать гигантский список кода, но все же можно быстро сказать, что «весь этот блок кода является конструктором», глядя на код/​​комментарии каждого метода.

Я знаю, что есть также сворачивание кода, которое я фактически использую в сочетании с блоками комментариев (я окружаю блоки комментариев с пользовательской складной областью). Причина, по которой я это делаю, - это то, что Code Folding отлично работает, когда весь код сложен, но когда код расширяется, они не выделяются, как гигантский блок комментариев. Поэтому я использую один, чтобы покрыть случай, когда весь мой код сведен к минимуму, а другой - для случая, когда весь мой код расширяется.

Однако это не практика, которую я вижу, использую много, поэтому мне интересно, считается ли это плохой практикой кодирования или чем-то еще. Я имею в виду, что это определенно помогает читабельности моего кода для меня, но я также не хочу, чтобы потенциальные работодатели причаливали очки за странный стиль кодирования.

Answer 1

Существует всегда практика используется в кодировании языков, как для JAVA вы можете увидеть следующее:

/** 
    Author : Gary 
    Method : testMethod 
    Parameters : param1, param2 
    Exception : ArrayOutOfBound, Exception 
    Description : It is a dummy method 
*/ 
public void dummyMethod(int param1, double param2) { 
    //Sample Method Body; 
    String abc = callDummyMethod(); 
} 

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

PS: комментариев однолинейных (//) никогда не рекомендуются в этой форме.