【问题标题】:Swift: Argument labels naming convention?Swift:参数标签命名约定?
【发布时间】:2017-07-04 12:39:53
【问题描述】:
假设我想使用一个函数隐藏/显示一个 UI 元素。正确的命名方式是什么?
func changeRefreshControlVisibilityTo(_ isVisible: Bool) {}
或
func changeRefreshControlVisibility(to isVisible: Bool) {}
人们对此有想法和/或参考吗?谢谢!
【问题讨论】:
标签:
swift
user-interface
naming-conventions
naming
【解决方案1】:
我个人不会选择这两个。 change 部分对我来说似乎是多余的,特别是考虑到它可能不会真正改变任何事情的事实——假设当前可见性是 false 并且您仍然可以将 false 设置为该方法的参数。
因此,如果您想坚持使用 change 的话,也许是这样的:
func changeRefreshControlVisibility() {}
或者对我来说,甚至更好:
func toggleRefreshControlVisibility() {}
够了吗?
如果你想公开交流使用这种方法后可见性有什么价值,为什么不简单:
func setRefreshControlVisible(_ isVisible: Bool) {}
无论如何,Swift 的 API 设计指南相当简短:
https://swift.org/documentation/api-design-guidelines/
所以我的总体印象是,你应该选择最适合你/你的团队的。