什么是好的函数或方法?

一个好的函数或方法必须遵守以下原则:

函数或方法在命名上应该具有描述其目的或功能的含义。当一个函数有一个有意义的名字时,它有助于阅读和理解。

例如,如果一个函数的目的是通过 ID 查找商品,我们就可以将其命名为“findGoodsById(String id)。 find一词还暗示可能会找到商品,也可能找不到该商品。
如果函数的名称将更改为
getGoodsById(String, id),它的含义发生了变化,因为现在它意味着没有后备;商品要么被找到,要么失败并可能抛出异常。

两者都是函数的有效名称,但它们具有不同的含义,因此它们的实现也应该不同。

我们建议函数或方法的参数应该少于3个,如果需要超过3个的参数,那么就应该重写它,并将参数放在一个数据持有者中,比如它的类、数据类、JavaScript 对象等,这是减少参数数量和组织数据的简单方法。

一个函数应该输出你所期望的数据,不多也不少。如果一个函数被命名为findAddress(latitude, longitude),它应该在给定的坐标中找到地址,如果没有地址,则返回 None、null、Empty 或任何合适的类型给定的语言。该函数不应该做其他任何事情,例如查找相邻地址或构建坐标记录。该函数可能具有诸如日志记录或分析之类的副作用,但这些对输入和输出是不可见的。

函数应该被设计成可测试的。例如下面的函数addProject,没有定义任何返回类型,因此它的可测试性是有问题的。当然,它可以根据内部实现的情况模拟进行测试,但我们只需简单地给它一个返回类型,我们就可以轻松地测试它。

public void addProject(Project project) {
    service.add(project);
}
展开阅读全文

页面更新:2024-03-20

标签:函数   目的   方法   可能会   坐标   含义   名字   名称   参数   类型   简单   地址   测试   商品   数据

1 2 3 4 5

上滑加载更多 ↓
推荐阅读:
友情链接:
更多:

本站资料均由网友自行发布提供,仅用于学习交流。如有版权问题,请与我联系,QQ:4156828  

© CopyRight 2020-2024 All Rights Reserved. Powered By 71396.com 闽ICP备11008920号-4
闽公网安备35020302034903号

Top