如何保持代码干净整洁？

Question

保持代码清洁和有条理对于将来的维护非常重要，特别是对于程序员循环（或被解雇，希望没有）的公司。

我一直在寻找谷歌和香港专业教育学院找到了一些可能有所帮助的事情，比如：正确地命名变量和方法等等......然而，请注意我尝试正确应用大部分规则的事实，我仍然有麻烦地正确组织我的代码，我会对所有内容进行评论，以便维护变得更容易。

我迷失在复杂的代码中，其中有许多嵌套语句，例如：if if内的for等等......

要解决这些问题，我可以用Netbeans来做，像这样：

Netbeans允许通过<editor-fold>标记压缩代码。现在可以，但问题出现在其他人必须修改此代码的地方，因为xml标记与IDE有关。

问题是：什么是正确的方式或模式，使代码易于理解和清理同时，而不是IDE依赖。

Answer 1

从哪里开始

如果您有许多类似于以下内容的难以理解的片段，我很确定您不会应用所有最佳做法：

  在if

内的if内{p> for

开始使用干净代码的一个非常好的地方是阅读与该主题相关的书籍。虽然书籍有时会受到批评，但它可以同时涵盖许多方面，并使教学，博客笔记等知识更具系统性。就个人而言，我可以推荐Robert C. Martin的清洁代码。

如果您熟悉理论，请练习很多。编写代码并进行改进。一次又一次。找一个更有经验的人并向他询问更难的案例也很有用。

我在下面提出了三点，从我的观点来看非常重要。

自我记录代码

首先，我会将评论数量减少到最小，避免使用虚线，＆＃34;编辑器折叠＆＃34;等等。如果您需要使用分隔符拆分代码 - 该类可能太长。请阅读更多关于好评和自我记录代码here的信息。

无条件编程

很多时候用一些OOP原则替换if-else和switch指令是个好主意。 This answer包含几个有用的链接。

包/类/方法大小

重新组织所有太大而不易理解的例程。使用OOP范例将长方法拆分为较小的，重新设计神类。该规则也适用于项目 - 您可以将其拆分为模块或子项目并重用。单一责任原则可能会有所帮助 - some examples。

Answer 2

  

一个好的代码几乎就是它自己的文档。

Java文档提供了有关如何以更好的方式编写代码的大量详细信息。

我的建议是：

使用正确的命名约定：

在你的代码中我可以看到一些代码味道，变量test和test2可能是其他程序员遇到麻烦的主要原因。

尝试制作模块：

制作模块也可以使代码易于理解。例如，使用长代码创建可能的方法并正确命名它们。我的老师曾告诉我：“如果你不能为方法命名或为你的方法考虑任何合适的名称，那就意味着你做错了”

评论被认为是重要的但我的意见是好的书面代码不依赖于评论。您可以添加它们来解释复杂的内容。

正确的缩进也很重要。