C#的“格式化”标准是什么?

7
在C# (.NET)中,普遍的“格式化”标准是什么?
例如,对于参数名称,目前我注意到使用camelCase而没有前缀,是这样吗?对于对象名称,也是用camelCase而没有前缀,对吗?
对于命名空间、类、函数和属性,单词的第一个字母大写,没有前缀,这样做是正确的(再次确认)吗?
“临时”对象如何格式化?
例如:
namespace TestNamespace
{
    class MyOwnCoolClass
    {
        MyOwnCoolClass(int length, BinaryWriter writer)
        {
            BinaryWriter tempbw = new BinaryWriter(length);
            return tempbw;
        }
    }
}

(注意:这段代码不是有效的,我知道,只是为了演示格式化。)谢谢!

7个回答

14

我不打算使用StyleCop,但是这个链接正好满足了我的需求。谢谢! - Lazlo

5

可以在类设计指南中找到微软的完整指南。虽然它有点老,但我还没有在MSDN上找到任何更新的内容,而且我认为它仍然是标准的推荐设置。


谢谢您的回答,但是280Z28的回答更符合我的问题。:) 不过还是点了个赞。 - Lazlo

2
我在过去一年中使用了微软和其他广泛接受的准则,写了这些指南。你可能想看一下,它还包括其他一些东西,比如设置项目等等,但所有的命名准则都在里面。 编辑: 我注意到这是一个旧版本,我有一个正在编写的新版本,其中包含很多好东西,但还没有完成。当它发布时,我会更新这篇文章。

1
作为一个独立开发者,从未得到过任何指导或约定,我发现这篇文章非常有启发性。但我很好奇您如何处理var和表单的代码页面。我看到了“源文件布局”一节,不知道是否适用于WinForm代码页面。此外,在“控件和组件”一节中,您指出应该使用ux来防止以后的编码更改。那么,使用var的心态是否也相同?感谢提供这个文档! - Refracted Paladin
1
新版本已完成并上传。您可以使用相同的链接进行下载。我通常每隔几个月更新一次此文档,包括重大更新。 - David Anderson
你真是个圣人!这听起来有点傻,但你不知道这对我这样的人有多大帮助...谢谢你。 - Refracted Paladin
我可能有点急躁了...因为那个还是昨天的一样...稍后我会再次检查。 - Refracted Paladin
非常欢迎!我希望我的规范对你有所帮助,就像其他下载它们的人一样 ;) - David Anderson
显示剩余6条评论

0
我建议您参考以下这个Coding Practices.
它涵盖了我在阅读大多数C#代码时看到的几乎所有内容,包括UI元素前缀。我个人虽然没有完全按照它的要求去做,但它可以给你一个很好的标准和良好/不良实践的概念。

0

有关微软编码标准的参考资料。Visual Studio 2005和2008内置了代码分析引擎,将指导您遵循这些编码标准,并指出一些最佳实践。右键单击项目,然后单击“在项目上运行代码分析”。

每当发现无效或不喜欢的代码部分时,它不仅会警告您,还会指向FxCop网站上的帮助资源。


0

MSDN: 命名指南

我倾向于遵循.NET框架的编码方式,以便我的代码与.NET框架保持一致。

我唯一的个人偏好是类变量的命名,我使用前缀“m_”来表示每个变量,例如private int m_count


0

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接