遵循函数最佳实践至关重要。避免以下反例：过长的函数函数没有文档字符串输出参数函数嵌套过多函数返回错误代码而非错误值
违反 Go 语言函数最佳实践的 5 个反例
在 Go 语言中编写高质量的代码时，遵循函数最佳实践至关重要。避免以下反例可以帮助您编写可维护、可读和高效的函数。
1. 过长的函数
func DoEverything(a, b int, c string, d bool) (int, error) {
if c == "" {
return 0, errors.New("c cannot be empty")
}
if !d {
return 1, errors.New("d must be true")
}
return a + b, nil
}
最佳实践： 将函数分解为较小的、可重用的函数。
2. 函数没有文档字符串
func DoSomething(x int) int {
return x * x
}
最佳实践： 为每个函数添加文档字符串，说明其目的、参数和返回值。
3. 输出参数
func Swap(a, b *int) {
tmp := *a
*a = *b
*b = tmp
}
最佳实践： 避免使用输出参数，因为它会使代码难以理解和调试。
4. 函数嵌套过多
func Nested(x int) int {
if x > 10 {
func inner(y int) int {
return y + 1
}
return inner(x)
}
return x
}
最佳实践： 将嵌套函数移出主函数，或使用闭包。
5. 函数返回错误代码而非错误值
func OpenFile(name string) int {
f, err := os.Open(name)
if err != nil {
return -1
}
return f.Fd()
}
最佳实践： 根据 Go 语言惯例，函数应返回错误值，而不是错误代码。
实战案例
考虑以下需要将列表转换为字典的函数：
// 不遵循最佳实践的示例
func ConvertListToDict(list []string) map[string]bool {
dict := make(map[string]bool)
for _, v := range list {
dict[v] = true
}
if len(dict) != len(list) {
return nil
}
return dict
}
此函数存在以下问题：
- 返回值为
nil，但文档字符串未说明此情况。 - 函数不处理重复元素，返回
nil也存在歧义。
遵循最佳实践的示例
// 遵循最佳实践的示例
func ConvertListToDict(list []string) (map[string]bool, error) {
dict := make(map[string]bool)
for _, v := range list {
if _, ok := dict[v]; ok {
return nil, errors.New("duplicate element in list")
}
dict[v] = true
}
return dict, nil
}
此函数解决了上述问题，并针对重复元素返回了一个错误值。
