6、函数编写的最佳实践与原则

函数编写的最佳实践与原则

1. 函数参数的理解与使用

1.1 输出参数与输入参数

输出参数比输入参数更难理解。我们在阅读函数时，通常习惯信息通过参数传入函数，再通过返回值传出。一般不会期望信息通过参数传出，所以输出参数常常会让我们产生困惑。例如，当看到一个函数调用时，很难立刻判断某个参数是输入还是输出。

1.2 单参数函数

单输入参数仅次于无参数，是比较好理解的情况。例如 SetupTeardownIncluder.render(pageData) 就很容易理解，显然是要对 pageData 对象中的数据进行渲染。单参数函数常见有以下几种形式：
- 询问型 ：对参数进行询问，如 boolean fileExists(“MyFile”) ，用于判断文件是否存在。
- 转换型 ：对参数进行操作并转换为其他类型返回，如 InputStream fileOpen(“MyFile”) ，将文件名转换为输入流。
- 事件型 ：有输入参数但无输出参数，程序将函数调用解释为一个事件，使用参数改变系统状态，如 void passwordAttemptFailedNtimes(int attempts) 。不过使用这种形式时要谨慎，函数名和上下文要能让读者清楚这是一个事件。

应尽量避免不遵循上述形式的单参数函数，例如 void includeSetu