使用注释块分割代码以提高可读性。好主意还是坏主意？

Question

所以我最近开始编程，有时我觉得需要用这样的注释块分隔我的代码：

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

*constructors*

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

例如，我可能有一个“构造函数”部分和一个“Getter/Setter”部分，或者一个包含所有 OK 按钮配置、单击侦听器等的“确定按钮实现”部分。这使我可以快速滚动浏览巨大的代码列表，但仍然能够快速判断“这整个代码块都是构造函数”，而无需实际查看每个方法的代码/cmets。

我知道还有代码折叠，我实际上将它与注释块结合使用（我用自定义折叠区域围绕注释块）。我这样做的原因是因为代码折叠在所有代码都被折叠时很棒，但是当代码被展开时，它们不会像一个巨大的注释块那样突出。所以我用一个来覆盖我所有的代码都被最小化的情况，另一个来覆盖我所有的代码被扩展的情况。

但是，我认为这不是一种经常使用的做法，所以我想知道它是否被认为是糟糕的编码做法或其他什么。我的意思是，这肯定有助于我的代码对我的可读性，但我也不希望未来的雇主因为奇怪的编码风格而扣分。

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：从不鼓励这种形式的单行 cmets(//)。