我目前正在清理一个大型 Java 代码库,我想知道 Java 类的正确(标准?)结构/顺序是什么。
我的意思是:
- 字段应该
public static final
在类的字段中排在第一位吗? - 静态初始化器应该在哪里?
private static
辅助方法应该在哪里?
PrepareStatement
另外,作为一个附带问题:在代码中对 s 进行大型硬编码 SQL 查询是个好主意吗?
我目前正在清理一个大型 Java 代码库,我想知道 Java 类的正确(标准?)结构/顺序是什么。
我的意思是:
public static final
在类的字段中排在第一位吗?private static
辅助方法应该在哪里?PrepareStatement
另外,作为一个附带问题:在代码中对 s 进行大型硬编码 SQL 查询是个好主意吗?
您应该更担心命名约定、清晰的代码文档和程序的整体正确性(即没有错误),之后您可以担心定义变量、方法等的顺序
回答(一些)你的观点:
static initializer
通常出现在课程的开头,如果它恰好出现在变量之后。private methods
可以到类的末尾(如果变量在末尾,则在变量之前),但这是偏好问题,因为通常阅读代码的人更关心public methods
类暴露给程序其余部分的内容PreparedStatement
你应该没问题。好吧,在这里你会找到 Java 代码约定:Java 代码约定
我真的不喜欢硬编码的 SQL 语句。但是,有时它们是必要的。看看你是否可以将它封装在一个库中(比如hibernate或其他东西),或者至少你可以把它分解成小的sql代码。
添加
我还想看看:How to Write Doc Comments for the Javadoc Tool以维护您的代码有据可查。