如何写出优秀的代码

简介: 如何写出优秀的代码


1.第一坨屎-变量

为了不让下任『接盘侠』看到代码骂娘,我劝你善良。请不要使用如下方式命名变量:

1.拼音命名(不会英文就去下载个某道词典,翻译一下嘛。name 总比 mingzi 好辨认吧?字数还少,还能国际通用)

2.使用简单字母命名(a/b等等,别说其他人,过两天自己都不晓得写了个什么鬼)更多精彩文章请关注公众号『Pythonnote』或者『全栈技术精选』

3.异想天开(不要随便拍脑袋起名,要做到见名知义。总不能一个 id 的列表,你叫个 item 吧?xxx_id_list 稍微强一些吧?)

4.不要命名冲突(最起码在一个函数内,不能重复。project 既是生产项目又是测试项目?变量不断被覆盖,奇奇怪怪的 bug 就够你喝一壶的了)

这种病的病根儿一般是词汇量匮乏,治疗建议某道翻译。

5.查询数据库时,变量与字段名、模型类或者表名不一致(查的 Product 就不要叫 Mobiles;查的 name ,就不要叫 leader

2.第二坨屎-注释

为了第二天代码还认识你,请你添加注释。

1.一定要添加注释,最起码重要的逻辑部分覆盖到。

2.注释要清晰、易懂、简单明了。

3.注释不是流水账,不是每一行代码的解释,而是某一块逻辑的说明。

4.对于复杂的数据结构请举例说明。

5.每个函数的说明文档起码要有。更多精彩文章请关注公众号『Pythonnote』或者『全栈技术精选』

3.第三坨屎-嵌套

1.不要里三层外三层的 if-else,逻辑判断可以有,但是一定有更加简明的表示方法。嵌套的层级太多,不仅难理解,还影响美观。

2.简单的一层 if-else ,有时三元运算符会更加方便。

3.若想你的程序执行效率高一些,就不要循环套循环。

4.无论何时何地都不要在循环里面有查询数据库的语句。也许一次访问,只需要查询几次数据库,但是用户量大时,能把你数据库搞瘫。多使用一些 bulk_create 或者 bulk_update 等等类似的批量操作方法,一次访问远比多次访问数据库效率高。

4.第四坨屎-逻辑

1.请将复杂的逻辑单独抽出来做成函数或者类,不要让你的接口内部过于复杂。否则即使有注释,也太晦涩难懂。

将复杂逻辑抽调后,不光能被其他地方调用,还能使你的接口清晰明了。

2.实现一个功能,肯定不止一种方法,要不断的去优化,去寻找一条最快最简单的路径。

当然优化的前提是存在,即使用笨办法也得先实现再说。

5.第五坨屎-校验

1.一定要添加必要的校验操作!一定要添加必要的校验操作!一定要添加必要的校验操作!重要的事情说三遍,想要保证程序的健壮性,永远不要相信用户的任何操作!(用户不是开发人员,一定会做出你想不到的操作。为了保证程序安全、数据安全,请添加校验)更多精彩文章请关注公众号『Pythonnote』或者『全栈技术精选』

2.常用的校验有:为空校验、长度校验、规则校验、常识性校验(最起码上限不能低于下限)、业务校验、边界情况校验等。

6.第六坨屎-单元测试

1.自动化远比人工可靠。

不是说人工偷懒,而是重复的点点点难免会有遗漏的情况。添加单元测试,就要可靠的多。

2.单元测试并不是负担,当你重构代码时,你会发现它的重要作用!

有单元测试做保障,测试通过就代表重构成功。不需要重复界面点点点,太浪费时间。当然前提是:你的单元测试是可靠的。

3.重要的方法、逻辑,单元测试一定要覆盖到,它会保证你的程序安全上线!更多精彩文章请关注公众号『Pythonnote』或者『全栈技术精选』

4.code_review 只能是看规范,看逻辑,肉眼能核对运行结果吗?提交代码先跑一遍单元测试,是否可靠的多?

这就体现出来自动化测试的好处了,最简单的方法,在 GitLab 上集成单元测试,这样提交代码后自动运行单元测试,不通过肯定不会合并到 master  分支,保证线上环境安全。

7.第七坨屎-重用

1.将公共的代码抽调出来,做成公共模块、通用组件。「减少程序代码量」,让程序起飞。

2.重用的优点不光是省代码这么简单,如果相同的代码这也有,那也有,出错怎么办?改几遍?「便于维护」

3.将常用的数字抽出一个常数文件,其他地方调用变量的形式使用,这样维护一个常数文件比维护分散在各个角落的代码要好的多。

相关文章
|
存储 API 数据库
微搭低代码密码加密存储
微搭低代码密码加密存储
|
9天前
|
人工智能 JavaScript Linux
【Claude Code 全攻略】终端AI编程助手从入门到进阶(2026最新版)
Claude Code是Anthropic推出的终端原生AI编程助手,支持40+语言、200k超长上下文,无需切换IDE即可实现代码生成、调试、项目导航与自动化任务。本文详解其安装配置、四大核心功能及进阶技巧,助你全面提升开发效率,搭配GitHub Copilot使用更佳。
|
3天前
|
JSON API 数据格式
OpenCode入门使用教程
本教程介绍如何通过安装OpenCode并配置Canopy Wave API来使用开源模型。首先全局安装OpenCode,然后设置API密钥并创建配置文件,最后在控制台中连接模型并开始交互。
1522 5
|
11天前
|
存储 人工智能 自然语言处理
OpenSpec技术规范+实例应用
OpenSpec 是面向 AI 智能体的轻量级规范驱动开发框架,通过“提案-审查-实施-归档”工作流,解决 AI 编程中的需求偏移与不可预测性问题。它以机器可读的规范为“单一真相源”,将模糊提示转化为可落地的工程实践,助力开发者高效构建稳定、可审计的生产级系统,实现从“凭感觉聊天”到“按规范开发”的跃迁。
1666 17
|
9天前
|
人工智能 JavaScript 前端开发
【2026最新最全】一篇文章带你学会Cursor编程工具
本文介绍了Cursor的下载安装、账号注册、汉化设置、核心模式(Agent、Plan、Debug、Ask)及高阶功能,如@引用、@Doc文档库、@Browser自动化和Rules规则配置,助力开发者高效使用AI编程工具。
1268 6
|
10天前
|
消息中间件 人工智能 Kubernetes
阿里云云原生应用平台岗位急招,加入我们,打造 AI 最强基础设施
云原生应用平台作为中国最大云计算公司的基石,现全面转向 AI,打造 AI 时代最强基础设施。寻找热爱技术、具备工程极致追求的架构师、极客与算法专家,共同重构计算、定义未来。杭州、北京、深圳、上海热招中,让我们一起在云端,重构 AI 的未来。
|
13天前
|
IDE 开发工具 C语言
【2026最新】VS2026下载安装使用保姆级教程(附安装包+图文步骤)
Visual Studio 2026是微软推出的最新Windows专属IDE,启动更快、内存占用更低,支持C++、Python等开发。推荐免费的Community版,安装简便,适合初学者与个人开发者使用。
1289 12
|
7天前
|
云安全 安全
免费+限量+领云小宝周边!「阿里云2026云上安全健康体检」火热进行中!
诚邀您进行年度自检,发现潜在风险,守护云上业务连续稳健运行
1180 2
|
13天前
|
人工智能 测试技术 开发者
AI Coding后端开发实战:解锁AI辅助编程新范式
本文系统阐述了AI时代开发者如何高效协作AI Coding工具,强调破除认知误区、构建个人上下文管理体系,并精准判断AI输出质量。通过实战流程与案例,助力开发者实现从编码到架构思维的跃迁,成为人机协同的“超级开发者”。
1012 94