函数代码规范

文章目录


前言

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

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

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

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

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

原则

原则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

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

相关推荐
shepherd1111 天前
JDK源码深潜(一):从源码看透DelayQueue实现
java·后端·代码规范
JinSo2 天前
pnpm monorepo 联调:告别 --global 参数
前端·github·代码规范
m0_651593912 天前
深入理解软件设计中的协议与规范:从理论到Java实践
java·软件工程·代码规范·设计规范
小苑同学2 天前
代码解析:《AGENTREVIEW: Exploring Peer Review Dynamics with LLM Agents》
代码规范
白衣鸽子5 天前
JavaDoc:自动化生成的可维护代码说明书
后端·代码规范
纯爱掌门人8 天前
我把前端踩坑经验总结成28条“涨薪秘籍”,老板夸同事赞,新手照着做准没错
前端·程序员·代码规范
月光番茄10 天前
模型文件识别与下载规范(跨平台版)
代码规范
Django强哥10 天前
JSON Schema Draft-07 详细解析
javascript·算法·代码规范
盗德11 天前
为什么要用Monorepo管理前端项目?(详解)
前端·架构·代码规范
小小前端_我自坚强11 天前
前端踩坑指南 - 避免这些常见陷阱
前端·程序员·代码规范