C# 风格：属性可以与其支持字段分组吗？

发布于 2024-11-08 05:56:53 字数 338 浏览 0 评论 0原文

我喜欢组织这样的简单属性：

private int foo;
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}

我一直在玩 StyleCop，它对我大喊大叫将字段放置在构造函数之后。只要该字段从未在属性之外被引用，这种样式是否被普遍接受？注：我意识到这涉及个人偏好，但我想知道在这个问题上是否存在普遍共识。

原文

I like to organize simple properties like this:

private int foo;
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}

I've been playing around with StyleCop, and it yells at me for placing fields after constructors. Is this style generally accepted, as long as the field is never referenced outside of the property? Note: I realize that there is personal preference involved, but I am wondering if there is a general consensus regarding this issue.

分享到QQ

分享到微博

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

发布评论

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

池予 2024-11-15 05:56:53

是的，这对我来说似乎很合理。

通常，我将所有字段和属性放在顶部，然后是构造函数，然后是方法 - 但如果您想将它们放在构造函数之后，这似乎也是合理的。

回复收藏 0 原文

末骤雨初歇 2024-11-15 05:56:53

如果您的属性将是简单的数据访问，请考虑使用自动属性：

public int Foo { get; set; }

编译器将代表您在幕后创建一个私有成员变量。

具体针对您的问题，不要过多关注 ReSharper 或 StyleCop 等工具。他们格式化代码的一些方式以及他们抱怨的事情确实是一个偏好问题。我不会将成员变量放在其公共属性附近，但我可以看到这会很方便。

If your properties are going to be simple data access consider using auto properties:

public int Foo { get; set; }

The compiler will create a private member variable behind the scenes on your behalf.

Specifically to your question, don't put too much stock in tools like ReSharper or StyleCop. Some of the ways they format code, and the things they complain about are truly a matter of preference. I do not put the member variables near their public properties, but I can see how this would be convenient.

回复收藏 0 原文

转角预定愛 2024-11-15 05:56:53

可能？由于这只会影响您团队中的人员，因此您必须弄清楚他们认为什么是最好的并遵循它。 Style Cop 的建议往往有点……过分了。

我通常将它们放在属性之后，因为上面的空间是为文档保留的。

// placed up here, it looks kinda weird, imho
// private int foo;
/// <summary>
/// The index of the Foo in the <see cref="Bar"/>
/// </summary>
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}
private int foo;

May? Since this only affects people on your team, you have to figure out what they think is best and go with that. Style Cop is often a bit... overboard on its recommendations.

I usually put them after the property, as the space above is reserved for documentation.

// placed up here, it looks kinda weird, imho
// private int foo;
/// <summary>
/// The index of the Foo in the <see cref="Bar"/>
/// </summary>
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}
private int foo;

回复收藏 0 原文