写更可读代码的建议?

我建议阅读以下内容:

• Pragmatic Programmer
• Clean Code
• Effective Java

我喜欢这些书:

• Clean Code
• Refactoring
• Agile Software Development

1. 命名-函数、变量、类等。。。一个好名字对于使代码可读有很大的帮助。名称应该是描述性的和明确的,并确保更新名称,如果事情的目的发生变化。

2. 分解复杂的函数-我的经验法则是,如果我不能在屏幕上同时容纳一个完整的函数/方法,它可能做得太多,需要分解。

3. 可读性胜于聪明-你会给更多人留下深刻印象的代码,他们可以阅读和维护5年后,比你会聪明地使用晦涩的语言功能

“如果你需要3级以上的缩进,你就完蛋了,应该修复你的程序”-Linus Torvalds

试试这些:

• 最小化嵌套
• 使用临时变量 -虽然它们会使代码看起来很笨拙,但有时也会极大地提高可读性。
• 分解大功能 -将大型功能分解为易于理解和测试的小型单一职责功能。

1. 保持干燥-不要重复你自己
2. 保持方法小型化
4. 仔细命名方法和变量-一个经过深思熟虑的名称比一个注释要好。

有许多代码风格的指导方针和启发式方法,但确保可读性的最佳方法是当有人编写代码时,其他人应该阅读它,然后批评它。

看一看 Code style

真的很好

编写可维护代码的关键是遵循一些基本的代码设计原则:

1. 单一责任原则-SRP-一个类必须实现一个责任。
2. DRY—几乎与SRP对等—不要重复自己—换句话说,不要让多个类实现相同的职责(因为这会导致相同代码的重复)
3. 制作应用程序的垂直切片,并将每个切片称为模块。提出一个模块化结构,模块之间有明确的依赖关系。发布项目的模块结构,并强制团队遵守该结构。显然没有周期性的依赖关系。在构建期间使用maven或apacheivy之类的工具进行依赖关系管理。
4. 使用AOP、decorators等策略将非功能性需求实现为水平需求。

有了这些东西,大部分代码就可以维护了。以上每一点本身都相当复杂。我绝对爱你 this book

祝你一切顺利

从“重构:改进现有代码的设计”一书开始- 马丁·福勒、肯特·贝克、约翰·布兰特、威廉·奥普戴克、唐·罗伯茨”

coding style -任何编码风格和 使用 develop code smells ,这将提示您使用错误代码。

有许多工具可以用来自动格式化代码,如果使用IDE,它可能有一个内置的工具。

我想到了一些:

• 不要不必要地 this 在方法前面,例如:

this.doSomething();

• 不要使用匈牙利语,例如:

private int mCount;

• 在使用局部变量的地方声明局部变量,最好尽可能晚

看起来问题是如何将不可读的代码转换成可读的代码,这与编写新的可读代码不同。

在做其他事情之前:

1. 如果尚未完成,请使用版本控制。
2. 如果尚未完成,请使用自动测试。

一般来说,客户并不关心代码的可读性。客户很关心软件是否按预期运行。