函数代码规范

文章目录


前言

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

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

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

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

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

原则

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

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

相关推荐
幻灵尔依15 小时前
前端编码统一规范
javascript·vue.js·代码规范
薛定谔的猫215 小时前
前端工程化系列(一):编码规范相关
前端·代码规范·前端工程化
围巾哥萧尘19 小时前
Batchify - AI 产品镜头生成器的产品经验🧣
代码规范
Hilaku20 小时前
深入URL和URLSearchParams:别再用正则表达式去折磨URL了
前端·javascript·代码规范
艾小码1 天前
代码审查总得罪人?3个技巧让你成为团队最受欢迎的技术大佬!
代码规范
不知名程序员第二部2 天前
前端-业务-架构
前端·javascript·代码规范
码间舞3 天前
你不知道的pnpm!如果我的电脑上安装了nvm,切换node版本后,那么pnpm还会共享一个磁盘的npm包吗?
前端·代码规范·前端工程化
shellvon3 天前
HTTP 请求头大小写差异:一次由 Clash 代理引发的疑难杂症
代码规范
奋进的电子工程师5 天前
汽车软件研发智能化:AI在CI/CD中的实践
人工智能·ci/cd·汽车·软件工程·软件构建·代码规范
大怪v5 天前
老乡,别走!Javascript隐藏功能你知道吗?
前端·javascript·代码规范