- Java锁的逻辑(结合对象头和ObjectMonitor)
- 还在用饼状图?来瞧瞧这些炫酷的百分比可视化新图形(附代码实现)⛵
- 自动注册实体类到EntityFrameworkCore上下文,并适配ABP及ABPVNext
- 基于Sklearn机器学习代码实战
工作这么多年,见过许许多多的代码,有的写的好,有的写的很糟糕。好的代码不外乎要做到你的代码可阅读、可维护、可扩展。说难不难,说简单也不简单,那么本文我将总结工作这么多年该如何写出整洁代码的一些实践.
欢迎关注个人公众号【JAVA旭阳】交流学习 。
干净代码最重要的原则之一是使用清晰且有意义的命名。这使其他开发人员可以轻松理解您的代码在做什么,并减少出现错误的可能性。例如,不使用名为“d”的变量来表示距离,而是使用名为“distance”的变量.
// Bad
int d = getDistance();
// Good
int distance = getDistance();
干净代码的另一个重要原则是使用适当的数据类型, 这可确保您的代码能够正常工作并减少出现错误的可能性。例如,不使用字符串来表示年龄,而是使用整数.
// Bad
String age = "25";
// Good
int age = 25;
干净的代码还与保持方法简短和重点突出有关,一个方法应该只做一件事并且应该易于理解,这使得测试和维护代码变得更加容易。例如,与其将处理订单的所有代码放在一个方法中,不如将其分解为更小的方法来进行验证、计算和保存.
// Bad
public void processOrder(Order order) {
// lots of code
}
// Good
public void processOrder(Order order) {
validateOrder(order);
calculateTotal(order);
saveOrder(order);
}
干净代码的另一个重要原则是编写清晰且有意义的注释。注释应该解释这段代码做的事情的原因,而不是它是如何做的。这使其他开发人员更容易理解您的代码.
// Bad, 只说明是递增
// increments count
count++;
// Good,说明业务需要每次加1
// Increment the count by 1
count++;
干净的代码还意味着使其易于阅读,使用空格和缩进来提高代码的可读性。这使其他开发人员更容易理解您的代码在做什么.
// Bad
if(a==b){c=d;}
// Good
if (a == b) {
c = d;
}
干净的代码要求 以正确的方式处理异常。您应该只捕获您可以处理的异常,并以特定的方式处理它们,避免包罗万象的异常处理程序.
// Bad
try {
// some code
} catch (Exception e) {
// handle exception
}
// Good
try {
// some code
} catch (IllegalArgumentException e) {
// handle specific exception
} catch (Exception e) {
// handle general exception
}
封装是一种有助于隐藏类的实现细节并使其更加灵活和可扩展的技术。通过使用封装,您可以更改类的实现而不影响其余代码.
// Bad
public class BankAccount {
public double balance;
// other methods
}
// Good
public class BankAccount {
private double balance;
// other methods
}
继承和多态性是面向对象编程的强大功能,可让您编写可重用的代码。通过使用继承,您可以创建一个包含公共代码的基类,然后创建继承该代码的子类。通过使用多态性,您可以编写以通用方式处理不同类对象的代码.
// Bad
public class Square {
// code specific to squares
}
public class Circle {
// code specific to circles
}
// Good
public class Shape {
// common code for all shapes
}
public class Square extends Shape {
// code specific to squares
}
public class Circle extends Shape {
// code specific to circles
}
通过使用设计模式,您可以编写易于理解、维护和扩展的代码。例如,策略模式是一种设计模式,可让您编写灵活且易于扩展的代码.
// Bad
public class OrderProcessor {
public void processOrder(Order order) {
// lots of code
}
}
// Good
public class OrderProcessor {
public void processOrder(Order order) {
OrderStrategy strategy = new OrderStrategy(order);
strategy.process();
}
}
干净的代码也与测试有关。通过编写单元测试,您可以确保您的代码按预期工作并且易于维护。单元测试是测试单个代码单元的自动化测试.
public class BankAccountTest {
@Test
public void testDeposit() {
BankAccount account = new BankAccount();
account.deposit(100);
assertEquals(100, account.getBalance());
}
}
干净的代码也与协作有关。通过使用代码审查、结对编程和指导,您可以提高代码质量并使其更易于理解和维护.
开发工具安装 checkstyle 这样的代码格式化工具来检查代码,同样, sonarQube 也可以帮助检查代码中的问题.
总而言之,代码不是写给自己看的,而是写给别人看的。你得想办法让你的代码能让别人容易看的懂、容易维护、能够很好的扩展,那么你才是一个合格的程序员,本文介绍了一些最佳实践和示例,希望对你有帮助.
欢迎关注个人公众号【JAVA旭阳】交流学习 。
最后此篇关于我总结了写出高质量代码的12条建议的文章就讲到这里了,如果你想了解更多关于我总结了写出高质量代码的12条建议的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。
我尝试理解[c代码 -> 汇编]代码 void node::Check( data & _data1, vector& _data2) { -> push ebp -> mov ebp,esp ->
我需要在当前表单(代码)的上下文中运行文本文件中的代码。其中一项要求是让代码创建新控件并将其添加到当前窗体。 例如,在Form1.cs中: using System.Windows.Forms; ..
我有此 C++ 代码并将其转换为 C# (.net Framework 4) 代码。有没有人给我一些关于 malloc、free 和 sprintf 方法的提示? int monate = ee; d
我的网络服务器代码有问题 #include #include #include #include #include #include #include int
给定以下 html 代码,将列表中的第三个元素(即“美丽”一词)以斜体显示的 CSS 代码是什么?当然,我可以给这个元素一个 id 或一个 class,但 html 代码必须保持不变。谢谢
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。 我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。 关闭 7 年前。
我试图制作一个宏来避免重复代码和注释。 我试过这个: #define GrowOnPage(any Page, any Component) Component.Width := Page.Surfa
我正在尝试将我的旧 C++ 代码“翻译”成头条新闻所暗示的 C# 代码。问题是我是 C# 中的新手,并不是所有的东西都像 C++ 中那样。在 C++ 中这些解决方案运行良好,但在 C# 中只是不能。我
在 Windows 10 上工作,R 语言的格式化程序似乎没有在 Visual Studio Code 中完成它的工作。我试过R support for Visual Studio Code和 R-T
我正在处理一些报告(计数),我必须获取不同参数的计数。非常简单但乏味。 一个参数的示例查询: qCountsEmployee = ( "select count(*) from %s wher
最近几天我尝试从 d00m 调试网络错误。我开始用尽想法/线索,我希望其他 SO 用户拥有可能有用的宝贵经验。我希望能够提供所有相关信息,但我个人无法控制服务器环境。 整个事情始于用户注意到我们应用程
我有一个 app.js 文件,其中包含如下 dojo amd 模式代码: require(["dojo/dom", ..], function(dom){ dom.byId('someId').i
我对“-gencode”语句中的“code=sm_X”选项有点困惑。 一个例子:NVCC 编译器选项有什么作用 -gencode arch=compute_13,code=sm_13 嵌入库中? 只有
我为我的表格使用 X-editable 框架。 但是我有一些问题。 $(document).ready(function() { $('.access').editable({
我一直在通过本教程学习 flask/python http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-wo
我想将 Vim 和 EMACS 用于 CNC、G 代码和 M 代码。 Vim 或 EMACS 是否有任何语法或模式来处理这种类型的代码? 最佳答案 一些快速搜索使我找到了 this vim 和 thi
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。 想改进这个问题?更新问题,使其成为 on-topic对于堆栈溢出。 7年前关闭。 Improve this
这个问题在这里已经有了答案: Enabling markdown highlighting in Vim (5 个回答) 6年前关闭。 当我在 Vim 中编辑包含 Markdown 代码的 READM
我正在 Swift3 iOS 中开发视频应用程序。基本上我必须将视频 Assets 和音频与淡入淡出效果合并为一个并将其保存到 iPhone 画廊。为此,我使用以下方法: private func d
pipeline { agent any stages { stage('Build') { steps { e
我是一名优秀的程序员,十分优秀!