使用注释块对代码进行分区以提高可读性。好主意还是坏主意?

时间:2014-12-11 10:34:34

标签: readability code-readability

所以我最近开始编程,有时我觉得需要将我的代码与这样的注释块分开:

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

*constructors*

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

例如,我可能有一个"构造函数"部分和" Getter / Setter"部分,或者" Ok按钮实现"所有OK按钮的配置部分,单击监听器等。这使我可以快速滚动一个巨大的代码列表,但仍然可以快速告诉"这整个代码块是构造函数"没有实际查看每个方法的代码/注释。

我知道还有代码折叠,我实际上与注释块结合使用(我用自定义折叠区域环绕注释块)。我这样做的原因是因为代码折叠在折叠所有代码时都很棒,但是当代码扩展时,它们不会像巨型注释块那样突出。因此,当我的所有代码都被最小化时,我使用一个来覆盖这个案例,而当我的所有代码都被扩展时,我用一个来覆盖这个案例。

然而,这并不是我认为使用的实践,所以我想知道它是否被认为是错误的编码实践或其他东西。我的意思是,这肯定有助于我的代码对我的可读性,但我也不希望未来的雇主为了奇怪的编码风格而停靠点。

1 个答案:

答案 0 :(得分:0)

在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 此表格永远不会鼓励单行评论(//)。