Swift:Argument标签命名约定?

时间:2017-07-04 12:39:53

标签: swift user-interface naming-conventions naming

假设我想使用一个函数隐藏/显示UI元素。命名它的正确方法是什么?

func changeRefreshControlVisibilityTo(_ isVisible: Bool) {}

func changeRefreshControlVisibility(to isVisible: Bool) {}

人们对此有想法和/或参考吗?谢谢!

1 个答案:

答案 0 :(得分:1)

我个人不会同意这些。 change部分对我来说似乎是多余的,特别是考虑到这一事实,它可能并没有真正改变任何东西 - 让我们说,目前的可见性是false,你仍然可以设置{{} 1}}作为此方法的参数。

所以如果你想坚持单词false,可能就是这样:

change

或者对我来说,更好的一个:

func changeRefreshControlVisibility() {}

就足够了吗?

如果您想在使用此方法后公开传达可见性的价值,为什么不简单:

func toggleRefreshControlVisibility() {}

无论如何,Swift的API设计指南相当简短:

https://swift.org/documentation/api-design-guidelines/

所以我的总体印象是你应该选择最适合你/你的团队的任何东西。