适当的Java类结构

时间:2013-02-14 16:25:55

标签: java coding-style refactoring conventions

我目前正在清理一个大型Java代码库,我想知道Java类的正确(标准?)结构/顺序是什么。

我的意思是:

  • public static final字段应该是Class的字段中的第一个吗?
  • 静态初始化器应该在哪里?
  • private static辅助方法应该在哪里?

另外,作为一个附带问题:在代码中对PrepareStatement进行大型的编码SQL查询是个好主意吗?

2 个答案:

答案 0 :(得分:1)

你应该更担心命名约定,明确代码文档和整体程序的正确性(即没有错误),之后你可以担心定义变量,方法等的顺序

This is the code convention for Java

回答(部分)你的观点:

  • static initializer通常出现在你的课程的开头,在变量之后,如果恰好是第一个。
  • private methods可以到你的类的末尾(如果它们在变量之前的变量之前),但它是偏好的问题,因为通常读取代码的人更关心{{1}该类暴露给程序的其余部分
  • 在程序中包含SQL语句或在外部存储(例如属性文件)取决于它们改变的频率;但只要您使用public methods,就应该没问题。

答案 1 :(得分:0)

嗯,在这里,您将找到Java代码约定:Java Code Conventions

我真的不喜欢带有编码的SQL语句。但是,有时它们是必要的。看看你是否可以将它封装在库(如hibernate或其他东西)上,或者至少你可以将它分解为次要的sql代码。

<强>添加

我还会看一下:How to Write Doc Comments for the Javadoc Tool来保存你的代码。