函数代码规范

文章目录


前言

"编写代码与写作其他类型的文章非常相似。在撰写论文或文章时,我们往往先将脑海中的想法直接记录下来,然后再进行精炼和打磨。初稿可能显得粗糙且杂乱无章,但我们可以不断地对其进行优化,直到它符合我们的预期。

当我开始编写函数时,它们往往冗长且复杂,包含大量的缩进和嵌套循环,以及过长的参数列表。函数名可能是随意选取的,并且常常会出现重复的代码片段。不过,我会为这些函数编写一套单元测试,确保每一行代码都能被覆盖到。

之后,我逐步对这些代码进行打磨:分解函数、修改命名、消除重复。我会调整函数的长度并将其移动到更合适的位置。有时候,我还会拆分类,同时确保所有的测试仍然能够通过。

我不会一开始就试图让函数完全符合优雅性的标准。我认为几乎没有人能做到这一点。"

以上内容来自《代码整洁之道》。

原则

原则1:函数体应短小

函数应该尽可能地简洁明了。简短的函数不仅易于理解,也更容易维护。

python 复制代码
def add(a, b):
    return a + b

原则2:只做一件事

判断一个函数是否承担了过多职责的方法之一,就是看它是否可以进一步拆分为多个更小的函数。每个函数最好只专注于完成单一的任务。

python 复制代码
def process_data(data):
    cleaned_data = clean_data(data)
    transformed_data = transform_data(cleaned_data)
    analyzed_data = analyze_data(transformed_data)
    return analyzed_data

原则3:函数参数

最理想的函数参数数量是零,其次是只有一个参数,再其次是两个参数。我们应该尽量避免使用三个或更多的参数。如果参数过多,考虑将这些参数封装成一个类或者结构体来传递。

python 复制代码
class Rectangle:
    def __init__(self, width, height):
        self.width = width
        self.height = height

def calculate_area(rectangle):
    return rectangle.width * rectangle.height

通过遵循这些基本原则,我们可以逐步提高代码的质量,并使其更加可读、可维护。正如写作一样,编程也需要不断迭代和完善。

相关推荐
mrsk16 小时前
每天一个小知识点,DRY究竟是什么?
前端·面试·代码规范
帅次2 天前
系统分析师-计算机系统-计算机系统概述&存储系统
系统架构·硬件架构·软件构建·个人开发·代码规范·设计规范
怪大叔95274 天前
eslint9.0之后如何安装新版本eslint+prettier规范
前端·vue.js·代码规范
Codebee4 天前
AI驱动的低代码革命:解构与重塑开发范式
人工智能·低代码·代码规范
赋范大模型技术社区6 天前
【LangChain 实战】多智能体协作实现浏览器自动化丨Agents 运行流程丨多工具串&并联调用
架构·github·代码规范
山有木兮木有枝_7 天前
JavaScript 设计模式--单例模式
前端·javascript·代码规范
hqxstudying7 天前
Java创建型模式---原型模式
java·开发语言·设计模式·代码规范
halloweencai7 天前
使用commitlint+husky规范代码提交的信息格式
代码规范
肖魏眸7 天前
vue3 格式化 : antfu 组合 prettier & eslint & 提交格式化校验
前端·代码规范
tianchang7 天前
策略模式(Strategy Pattern)深入解析与实战应用
前端·javascript·代码规范