知识卡片

问题卡 · 5626.c.7.b

简短名字需要局部共识

理解等级:中级

短名能否读懂,取决于作用范围和共同含义。循环中的i常表示索引、v表示元素,声明就在附近时,名称不必重复携带整个类型信息;离声明越远或角色越复杂,就越需要更明确的名字。

一致性比固定字数重要。用users表达用户集合,通常比userSlice更能说明业务角色;但不能把标准库单字母频率当成所有变量都该缩成一个字母的理由。

计数函数中,函数名已说明正在数rune,局部计数器可以叫count;这让函数、参数和局部名字分担解释,而不是每个名字都重复整句话。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 2 处

    • · 查看原书依据

      一致意味着代码中相同或相似的命名所传达的含义是相同或相似的,这样便于代码阅读者或维护者猜测出变量的用途。 这里大致分析一下Go标准库中常见短变量名字所代表的含义,这些含义在整个标准库范畴内的一致性保持得很好。 变量v、k

    • · 查看原书依据

      我们看到,至少在for循环这个上下文中,index、value携带的信息并不比i、v多。 这里引用一下2014年Andrew Gerrard在一次关于Go命名演讲[1]中用的代码,我们再来感受一下Go命名惯例带来的效果:

    参考来源

    - 位置:《Go语言精进之路 _ 从新手到高手的编程思想,方法和技巧 = Go programming from beginners》第07章《7.1 简单且一致》(来源项目book-sources:extracted/Go语言精进之路 _ 从新手到高手的编程思想,方法和技巧 = Go programming from beginners/_epub-src/Text/Chapter7_0001.xhtml;spine 34,归一字符[3142,3252)) - 结论依据:原文解释保持短名一致、声明距离和避免冗余类型后缀,支持按语境取舍。 - 原始内容:一致意味着代码中相同或相似的命名所传达的含义是相同或相似的,这样便于代码阅读者或维护者猜测出变量的用途。 这里大致分析一下Go标准库中常见短变量名字所代表的含义,这些含义在整个标准库范畴内的一致性保持得很好。 变量v、k 补充原书证据:spine 35 / extracted/Go语言精进之路 _ 从新手到高手的编程思想,方法和技巧 = Go programming from beginners/_epub-src/Text/Chapter7_0002.xhtml;归一字符[330,440)。 - 结论依据:本小节用RuneCount两版命名展开相同的上下文原则,作为明确补充来源。 - 原始内容:我们看到,至少在for循环这个上下文中,index、value携带的信息并不比i、v多。 这里引用一下2014年Andrew Gerrard在一次关于Go命名演讲[1]中用的代码,我们再来感受一下Go命名惯例带来的效果: