30多年的软件经验,总结出10个编写出更好代码的技巧

简介:

30 多年的软件经验,总结 10 个最佳妙招。

那么,何以敲出一手好代码?

好代码可以定义为易读、易懂、易调试、易改,最重要的还要少缺陷。显然,要想敲出一手好代码,是要花不少时间,但这在长久来看是有意义的,因为你可以花更少时间及精力去维护和复用你的代码。

30多年的软件经验,总结出10个编写出更好代码的技巧

事实上,我们可以将好代码等同于可复用的代码,这也是下面提到的重要原则之一。代码可能只是完成了编程工作中短期目标的特定功能,但如果没人(包括你自己)愿意复用你的代码,这代码在某种程度上可以说是不足且有缺陷的。要么太复杂、要么太具体、要么在不同情况下极有可能崩掉,或者其他程序员可能不相信你的代码。

下面无论你的经验水平如何,如果你始终如一地将下面的妙招应用到你的代码中(包括你的实验或者原型),那么一手好代码随手可得。

1、遵循单一责任原则

函数在程序员的库中是单一最重要的抽象形式。可以被复用的机会越多,你要写的代码就越少,这些代码就越可靠。遵循 单一责任原则 的小小函数更有可能被重新使用。

2、最小化共享状态

应该将函数之间的隐式共享状态最小化,无论它是文件作用域变量还是对象的成员字段,这有利于显式地将所需的值作为参数。当明确函数实现所需结果时,代码变得容易理解和重用。

对此可以得出一个结论,你应该优先选择静态无状态变量而不是对象的成员变量。

3、本地化副作用

理想的副作用(例如打印到控制台、记录、改变全局状态、文件系统操作等)应该放置在单独的模块中,而不是分散在整个代码中。功能上的副作用往往违反了单一的责任原则。

4、优先选择不可变的对象

如果一个对象的状态在其构造函数中设置一次,并且不再次更改,则调试变得容易得多,因为一旦构造正确就保持有效。这是降低软件项目复杂性的最简单方法之一。

5、多用接口少用类

接受接口的函数(或C++中的模板参数或概念)比在类上操作的函数可重用性更强。

6、对模块应用良好的原则

将软件项目分解成更小的模块(例如库和应用程序),以实现模块化重用。模块的一些关键原则是:

  • 最小化依赖关系
  • 每个项目都应该有一个单一明确的功能
  • 不要重复

你应该努力让你的项目保持小巧和明确。

7.避免继承

在面向对象编程中,继承,特别是虚拟函数在可重用性方面往往是一个死穴。我很少能成功地使用能覆盖类的库。

8.同设计和开发一样进行测试

我并不是测试驱动开发的铁杆拥护者,但在你开始编写测试代码时,编写测试自然遵循了许多指导方针。它也有助于早点将错误暴露出来。避免编写无用的测试,良好的编码意味着更高级的测试(例如,单元测试中的集成测试或功能测试)在显示缺陷方面更有效。

9.优先选择而不是手写标准库

我无法告诉你需要多久才能看到一个 std :: vector 或 std :: string 更好的版本,但它几乎总是浪费时间和精力。除了一个显而易见的事实,那就是你正在把 bug 引入一个新的地方。(见技巧10)其他程序员不太可能重用您的代码,而不是那些被广泛理解、支持和测试的代码。

10.避免写新代码

最重要的一点是,每位程序员应遵循:“ The best code is the code that isn’t written ”(最好的代码是不用被复写的代码)。你的代码越多,缺陷就越多,找到并修复 bug 就越困难。

在编写一行代码之前先问问自己,有没有一个工具,函数或库已经做了你所需要的功能?你真的需要自己去实现这个功能,而不是调用另一个已经存在的功能吗?

总结 编程就好比是一种艺术形式或者一项运动,你只有通过不断地练习,不断地向他人学习,才能不断地提高代码的质量,这些都将有利于你成为更加高效的程序员。


作者:陈云龙译

来源:51CTO

相关文章
|
Shell 开发工具 开发者
mac出现无法打开“*“,因为无法验证开发者 问题解决
mac出现无法打开“*“,因为无法验证开发者 问题解决
7162 0
mac出现无法打开“*“,因为无法验证开发者 问题解决
|
人工智能 前端开发 JavaScript
【AI】命令行调用大模型
通过命令行调用AI大模型以提高效率,文章介绍了一个使用前端npm的方法。首先创建npm包项目,初始化配置,然后编写`constant.js`、`kiwi.js`和`main.js`三个文件,分别存放API密钥、调用接口和主逻辑。在`kiwi.js`中使用axios与大模型API交互,`main.js`接收命令行参数并输出结果。通过修改`package.json`设置入口文件,并使用`npm link`全局安装,实现命令行调用,如`moon 你好`。
1019 0
|
人工智能 自然语言处理 测试技术
用图灵测试检验AI尤其是大语言模型,真的科学吗?
【9月更文挑战第25天】《Does GPT-4 Pass the Turing Test?》一文评估了先进AI模型GPT-4的图灵测试表现。尽管GPT-4在某些对话中成功迷惑了参与者,但其整体成功率仅为41%,低于人类的63%。图灵测试作为评估AI语言能力的工具依然有效,但存在局限性,如无法评估AI的认知机制且受主观判断影响。此外,测试还引发了关于AI智能及伦理的讨论。
1082 6
|
10月前
|
存储 弹性计算 安全
阿里云服务器2核8G与4核16G配置选购参考:价格、性能及适用场景
2核8G、4核16G配置是很多个人和企业用户搭建网站和中小型数据库系统等场景时首选的云服务器配置,现在购买2核8G配置最低年付价格只要652.32元/1年,4核16G配置短期租用可以选择月付,现在89元即可购买到经济型e实例4核16G10M带宽配置1个月,年付选择通用算力型u1实例价格为1196.64元/1年起。本文为大家解析阿里云服务器2核8G与4核16G配置的租用费用,热门实例适用场景,以供参考和选择。
|
5月前
|
XML Shell 网络安全
【零基础教程】从零部署 NewBie-image-Exp0.1:避开所有源码坑点
NewBie-image-Exp0.1 是基于 Next-DiT 的 3.5B 参数动漫图像生成模型,支持 XML 结构化提示词,擅长多角色与属性控制。本文详解其部署全流程,涵盖环境配置、依赖安装、源码 Bug 修复(如浮点索引、维度不匹配)、本地离线安装技巧及推理脚本编写,助你一键避坑,稳定生成高质量图像。
1566 4
|
6月前
|
人工智能 监控 供应链
企业如何应用数据中台?数据中台系统推荐(2025年12月更新)
在AI与数字化融合背景下,数据中台已成为企业实现数据资产化、驱动业务创新的核心引擎。本文系统解析其核心应用场景与落地路径,对比瓴羊Dataphin、字节Dataleap、奇点云DataSimba等主流产品,从技术亮点、适用场景、资质认证等维度提供选型指南。尤其推荐瓴羊Dataphin,凭借AI驱动、全链路能力与多云兼容性,助力企业高效释放数据价值,赋能数字化转型。
|
6月前
|
API
【剪映小助手】获取草稿文件列表
获取草稿文件列表。该接口用于获取指定草稿ID对应的所有文件列表,可以查看草稿中包含的素材文件、配置文件等信息。通常用于草稿内容的预览、文件管理或状态检查。
1324 0
|
10月前
|
机器学习/深度学习 搜索推荐 算法
揭秘京东 API,让京东店铺商品推荐更懂用户
在电商时代,京东API通过大数据与机器学习,助力店铺实现精准商品推荐。本文揭秘其核心机制与优化策略,助您打造更“懂”用户的推荐系统,提升转化率与用户体验。
|
人工智能 安全 BI
2024年度云治理企业成熟度发展报告解读(一)云市场发展洞察
从2023年开始,阿里云携手埃森哲每年发布《云治理企业成熟度年度发展报告》,通过数据来解读企业在云上的稳定性、安全、效率、成本等方面的发展现状,并反映各行业头部客户的技术演进趋势。该报告已成为了解中国云计算行业发展趋势的重要参考。这次,埃森哲将带来最新出炉的2024年度发展趋势报告(导读版)解读。
2024年度云治理企业成熟度发展报告解读(一)云市场发展洞察
|
Java 数据安全/隐私保护
Java 包(package)的使用详解
Java中的包(`package`)用于组织类和接口,避免类名冲突并控制访问权限,提升代码的可维护性和可重用性。通过`package`关键字定义包,创建相应目录结构即可实现。包可通过`import`语句导入,支持导入具体类或整个包。Java提供多种访问权限修饰符(`public`、`protected`、`default`、`private`),以及丰富的标准库包(如`java.lang`、`java.util`等)。合理的包命名和使用对大型项目的开发至关重要。
1534 3