Cocoa 中的实例变量命名约定

发布于 2024-08-10 19:47:53 字数 580 浏览 7 评论 0原文

这个问题是关于 Objective C 和 Cocoa 中的变量命名风格。我只是想强调，我不是在寻找“正确”的答案，只是在寻找好的想法。

我读过 Apple 和 Google 的 Objective C 风格指南，但我对它们都不太满意。苹果的指南没有关于实例变量与局部变量的任何真正的风格建议。事实上，Cocoa 库本身似乎非常高兴拥有与实例变量同名的函数参数。这让我个人感到畏缩。

谷歌指南指定实例变量应使用尾随下划线表示。好吧，一切都很好，但它建议我们用 @synthesize property = property_ 合成每个公共属性。我不知道其他人是怎么想的，但如果我要对项目中的每个实例变量都这样做，那我就该死了。我认为这是一个浪费且令人困惑的解决方案。

我很想使用对象属性的 myX（例如“myInstanceVariable”）命名样式，但我很少在 Objective C 中看到这种样式。

那么是的，你用什么？我不知道有什么你认为有用的样式约定吗？您认为函数参数与实例变量同名是否危险，尤其是在多个开发环境中？谢谢大家！

注意 - 正如许多人指出的那样，我的术语在 OP 中是错误的。如果原来的措辞损害了清晰度，我深表歉意，但我认为要点仍然很明确。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

素罗衫 2024-08-17 19:47:53

我倾向于使用无前缀的实例变量名称（请注意，“成员变量”是一种 C++ 主义，因为它暗示结构和类主要是可互换的，而 Objective-C 中的情况并非如此）），并且在出现歧义的情况下，我使用 Smalltalk 约定，通过“a”或“an”的类型来命名参数，例如：（

- (void)setFoo:(SOFoo *)aFoo;
{
    foo = aFoo;
}

当然，在现代 ObjC 中，您可以使用一个属性。）

使用 theFoo 代替 aFoo 也很常见；请参阅此问题的答案。

如果您确实担心冲突，那么 Google 惯例是有意义的。如果您使用 Xcode 文本宏或类似补全字典或 Accessorizer 来生成您的指令，采用起来非常简单。

请注意， Cocoa 键值编码指南几乎假设（a）您不为实例变量名称添加前缀/后缀，或者（b）您为它们实现（或合成）非前缀/后缀访问器。正如其他人提到的，不要使用 _ 前缀；它是为 Apple 在其框架中使用而保留的。

I tend to use non-prefixed instance variable names (note that "member variable" is a C++ism as it's suggestive of structures and classes being mainly interchangeable, which is not the case in Objective-C), and in cases where ambiguity arises, I use the Smalltalk convention of naming the parameter by its type with "a" or "an", e.g.:

- (void)setFoo:(SOFoo *)aFoo;
{
    foo = aFoo;
}

(of course, in modern ObjC you'd use a property for this.)

Using theFoo instead of aFoo is also somewhat common; see the answers to this question.

The Google convention makes sense if you're really worried about conflicts. If you use an Xcode text macro or tool like Completion Dictionary or Accessorizer to generate your directives, it's pretty simple to adopt.

Note that the Cocoa key-value coding guidelines pretty much assume either (a) you do not prefix/suffix your instance variable names, or (b) you implement (or synthesize) non-prefixed/suffixed accessors for them. As someone else mentioned, do not use the _ prefix; it's reserved for Apple's use in their frameworks.

回复收藏 0 原文