美文网首页
iOS 给函数和变量取个合适的名字

iOS 给函数和变量取个合适的名字

作者: 黑暗森林的歌者 | 来源:发表于2016-07-10 19:18 被阅读172次

1、明确函数要做什么
  在给函数命名前,明确函数到底要做什么。这有利于给函数命名。
2、以动词开头
  函数总是做些什么,所以当然要以动词开头。
3、尽量不要以 do 开头
  do 并不能给我们提供任何函数的信息。相比之下,search, compute, handle 之类的动词暗示着函数大概做了什么。
4、返回布尔值的方法以 is 或 are 开头
  用 is 还是 are 取决于判断主体是单个还是多个。
5、合理的使用 get 作为函数名字的开头
  所有有返回值的函数,好像都可以用 get 作为函数名字的开头。但以 get 开头的函数应该表示取某属性,否则就不应该用 get 开头。比如,从服务器上获取用户列表,这个方法可以叫 fetchUserList
,而不是 getUserList
;获取某个范围内的所有质数,可以叫 caculatePrime

6、不要包含上下文信息
  如有个 user 对象,有个获取 user 的 id 的函数,应该叫 getId
而不是 getUserId

7、不要包含函数参数的信息
  如用一个 id 和 token 找用户的方法,应该叫 findUser(userId, token)
而不是 findUserByUserIdAndToken(userId, token)
。如果以 findUserByUserIdAndToken
来命名,那么如果以后函数要支持用其他方式查找用户怎么办,又或是不支持用 token 查找怎么办。

相关文章

  • iOS 给函数和变量取个合适的名字

    1、明确函数要做什么在给函数命名前,明确函数到底要做什么。这有利于给函数命名。2、以动词开头函数总是做些什么,所以...

  • 如何给函数取个合适的名字

    对程序员来说,下面的几个任务,哪个最难? 给函数,变量等命名 向别人解释我们做什么(或者不做什么) 任务估时 与别...

  • 修Bug注意事项

    Bug出现的场景: 1.将变量名和函数名取成了相同的名字:有的时候,我们会不注意的时候,将变量的名字和函数的名字取...

  • C++自学计划-引用-13

    C++中的引用的意思是,给变量取一个名字,老实说有点难以理解为什么要这么做啊。变量就是给值取一个名字,这里引用就是...

  • Emacs: 自动插入翻译后的字符串

    对于我这种英语渣来说, 有时候给一个函数或者变量取一个适当的名字还是比较麻烦的, 一般都要打开 Google 翻译...

  • 《Python編程從入門到實踐》學習筆記

    实际操作中给变量取的名字要可读性强,我这里给变量取的名字非常简短,只是为了方便理解。 第 1 章 起步 win+s...

  • Python学习:函数式编程

    高阶函数: 变量可以指向函数,函数的名字就是变量,函数可以作为其他函数的参数;map,reduce,filter和...

  • 第5天-python基础-函数与模块

    定义函数 Python中每个函数都有自己的名字、自变量和因变量。我们通常把Python中函数的自变量称为函数的参数...

  • C语言(iOS)05_1

    // 函数:完成某一功能的代码段 // 函数名: 给这段代码取一个名字,以后就可以通过这个名字来代替这段代码。 /...

  • Swift基础--函数

    Swift基础--函数 函数式用来完成特定任务的独立的代码块.我们给一个函数起一个合适的名字,用来表示函数做什么,...

网友评论

      本文标题:iOS 给函数和变量取个合适的名字

      本文链接:https://www.haomeiwen.com/subject/pvmdjttx.html