Java 如何保持代码整洁有序?
保持代码整洁有序对于未来的维护非常重要,特别是对于程序员循环(或被解雇,希望不会)的公司 我一直在谷歌上搜索,我发现几乎没有什么可以帮上忙的,比如:正确命名变量和方法等等。。。然而,尽管我试图正确地应用这些规则中的大多数,但我仍然无法正确地组织代码,并且我会对所有内容进行注释,以便维护变得更容易 我迷失在复杂的代码中,其中有许多嵌套语句,如:Java 如何保持代码整洁有序?,java,performance,optimization,netbeans,ide,Java,Performance,Optimization,Netbeans,Ide,保持代码整洁有序对于未来的维护非常重要,特别是对于程序员循环(或被解雇,希望不会)的公司 我一直在谷歌上搜索,我发现几乎没有什么可以帮上忙的,比如:正确命名变量和方法等等。。。然而,尽管我试图正确地应用这些规则中的大多数,但我仍然无法正确地组织代码,并且我会对所有内容进行注释,以便维护变得更容易 我迷失在复杂的代码中,其中有许多嵌套语句,如:ifinsideifinsidefor,等等 为了解决这些问题,我可以使用Netbeans,如下所示: Netbeans允许通过标记压缩代码。现在还可
if
insideif
insidefor
,等等
为了解决这些问题,我可以使用Netbeans,如下所示:
Netbeans允许通过
标记压缩代码。现在还可以,但问题是其他人必须修改此代码,因为xml标记依赖于IDE
问题是:正确的方法或模式是什么,使代码易于理解并同时保持干净,而不是依赖于IDE
好的代码基本上就是它自己的文档
Java文档提供了大量关于如何更好地编写代码的详细信息
我的建议是:
使用适当的命名约定:
在您的代码中,我可以看到一些代码气味,test和test2变量可能会给其他程序员带来麻烦
尝试制作模块:
制作模块也可以使代码易于理解。例如,用长代码创建可能的方法并正确命名它们。我的老师曾经告诉我:“如果你不能为你的方法命名或想出合适的名字,那就意味着你做错了。”
注释被认为很重要,但我的观点是好的书面代码不依赖于注释。您可以添加它们来解释什么是复杂的
适当的缩进也很重要。从哪里开始
我敢肯定,如果您有许多难以理解的片段,您不会应用所有的最佳实践,这些片段类似于:
if
insideif
insidefor
从干净代码开始的一个非常好的地方是阅读一本与该主题相关的书。尽管书籍有时会受到批评,但它可以同时涵盖许多方面,并使教程、博客笔记等知识更加系统化。就个人而言,我可以推荐Robert C.Martin的Clean代码
如果你熟悉一个理论,就要多练习。编写代码并改进它。一次又一次。找到一个更有经验的人,向他询问更困难的案件,也是很有用的
我提出了以下三点,从我的观点来看,这三点非常重要
自文档代码
首先,我会尽量减少评论的数量,避免虚线、“编辑折叠”等等。如果需要使用分隔符分割代码,则类可能太长。请阅读更多关于好的注释和自我记录代码的信息
无条件编程
很多时候,用一些OOP原则替换if-else
和switch
指令是个好主意。包含两个有用的链接
包/类/方法大小
重新组织所有太大而难以理解的例程。使用OOP范例将长方法拆分为更小的类。该规则也适用于项目-您可以将其拆分为模块或子项目并重用。单一责任原则可能会有所帮助-。很好地记录并遵循Java的约定。差不多吧。如果代码不是自我解释的,您可以向代码中添加一些注释。这是一个相当广泛的问题,实际上并不是一个特定的编程问题。也许它最适合穿?不确定。。无论哪种方式,请退房。保持代码整洁和组织的一个好方法是遵守阅读:你会得到许多关于如何简化复杂代码逻辑的想法(如你所描述的,许多嵌套的if/else)。@VinceEmigh这个问题对程序员来说不太合适-它很快就会被否决并结束,请参阅推荐阅读:不要这样做。将你的方法保持在20-30行以下,你就不会觉得有必要在它们里面折叠。对于复杂的代码,唯一可行的办法就是避免它。“提取方法”是你最好的朋友。