在使用Java进行代码审查之前要记住的重要事项

Question

我刚刚使用Java创建了一个中型Web应用程序，一个自定义MVC框架，javascript。我的代码将在放入制作服务器（内部使用）之前进行审核。

构建此应用程序的主要目的是解决内部使用的小问题，并了解我的雇主使用的定制MVC框架。所以，我的应用程序经历了 MANY 迭代，功能更改和添加。

所以，底线，代码非常脏，这是我的第一个“产品级”Java应用程序。

您有什么建议，在代码审核之前我应该​​做些什么基本的检查/评估？

我正在考虑：

1. Java最佳实践（约定）

2. 让维护它的开发人员易于理解代码。 （不会是我）

3. 我注意到，我创建了一些不必要的对象，并使用了hashmaps / arraylists，可以轻松使用其他一些数据结构并实现解决方案。那么，这值得改变吗？

更新

Your Code Sucks and I Hate You: The Social Dynamics of Code Reviews

Answer 1

单元测试，它们应作为构建的一部分自动化。您应该已经拥有这些，但如果没有，请立即执行此操作。它肯定会使重构变得更容易，同时也可以提高您对代码（以及将要维护它的人）的一般信心。

Answer 2

如果你还没有，（假设你使用像eclipse这样的IDE）

• 获取插件checkstyle和findbugs
• 完成他们的配置并调整你的风格
• 在您的代码上运行它们
• 解决所有报告的问题

你也可以调整eclipse本身的编译器警告设置，并可能使报告的内容更加严格。

查看代码结构：

• 获取插件jdepend
• 调查您的包结构

针对接口的代码（Map，List，Set）而不是实现类（HashMap，ArrayList，TreeSet）

完成你的Javadoc并在所有重构后检查它是否是最新的。

添加JUnit测试;如果你没有时间来测试整个应用程序，至少要为你从现在发现并解决的每个bug创建一个测试。这有助于“随时”增加测试集。

下次设计和构建您的应用程序，最终目标即将到来。总是假设下一个必须维护代码的人知道如何找到你： - ）

Answer 3

<强>记录日志。

更容易被忽视的事情之一是伐木的重要性。你需要有一个像样的测井方法。即使这是一个内部应用程序，请确保基本日志可以帮助常规用户查找问题并提供更详细的日志记录，以便您（开发人员）知道去哪里。

Answer 4

评论你的代码，解释为什么它正在做它正在做的事情以及做了什么假设。

尽量减少变异状态的数量。

尝试删除您可能拥有的任何单身人士。