Java类通常分为逻辑“块”。是否有标记这些部分的约定?理想情况下,主要的IDE将支持它。
我个人使用此方法:
//// Section name here ////
但是,某些编辑器似乎对此有问题。
例如,在Objective-C代码中,您可以使用以下方法:
#pragma mark - #pragma mark Section name here
这将导致XCode中的菜单如下所示:
我个人使用80个字符的行分隔符,如下所示:
public class Client { //================================================================================ // Properties //================================================================================ private String name; private boolean checked; //================================================================================ // Constructors //================================================================================ public Client() { } public Client(String name, boolean checked) { this.name = name; this.checked = checked; } //================================================================================ // Accessors //================================================================================ public String getName() { return name; } public void setName(String name) { this.name = name; } public boolean isChecked() { return checked; } public void setChecked(boolean checked) { this.checked = checked; } }
当然,对于这么小的POJO来说,这似乎有点过大了,但是请相信我,它在某些大型项目中非常有用,因为我不得不浏览大型源文件并快速找到我感兴趣的方法。这也有助于理解源代码结构。
在Eclipse中,我创建了一组自定义模板(例如Eclipse的Preferences对话框中的Java-> Editor-> Templates),这些模板可以生成这些栏。-sepa(用于访问器的SEParator)-sepp(用于属性的SEParator)-sepc(用于构造函数的SEParator)等
我还修改了标准的“新类”模板(“ Eclipse首选项”屏幕中的Java->代码样式->代码模板)
另外,还有一个旧的Eclipse插件,称为Coffee- bytes,它增强了Eclipse折叠部分代码的方式。我不知道它是否仍然有效,但我建议可以通过添加特殊注释(例如// [SECTION]等)来定义任意可折叠区域。它在最新的Eclipse版本中仍然可能有效,因此请看一下。