Question

在C＃（。NET）中，常规的“格式化”标准是什么？

例如，对于参数名称，到目前为止我注意到没有前缀的camelCase，是吗？对于对象名称，camelCase也没有前缀，对吗？

对于名称空间，类，函数和属性，单词的首字母大写且没有前缀，这是否正确（再次）？

“临时”对象是如何格式化的？

示例：

namespace TestNamespace
{
    class MyOwnCoolClass
    {
        MyOwnCoolClass(int length, BinaryWriter writer)
        {
            BinaryWriter tempbw = new BinaryWriter(length);
            return tempbw;
        }
    }
}

（注意：此代码无效，我知道，这只是为了演示格式化）。谢谢！

Answer 1

如果您使用StyleCop，则会与Microsoft .NET Design Guidelines for Developing Class Libraries保持良好的一致性。 StyleCop还强制执行一些额外的操作，例如间距，文件中项目的排序以及非公共代码元素的命名。

Answer 2

可以在Class Design Guidelines中找到Microsoft的完整指南。它已经过时了，但我还没有在MSDN上发现任何更新，我相信它仍然是标准设置的推荐

Answer 3

我在去年使用MSFT和其他广泛接受的指南中的各种指南撰写了these guidelines。您可能想要查看它，它也有其他的东西，比如设置项目和诸如此类的东西，但所有的命名指南都在那里。

编辑我注意到这是一个旧版本，我有一个新版本，我已经写了一段时间，它包含很多好东西，但它没有完成。我会在发布时更新这篇文章。

Answer 4

我会看一下以下Coding Practices.

它几乎涵盖了我在大多数C＃代码中看到的所有内容......包括前缀UI元素。我个人并不遵循这封信，但它让你对一般标准和好/坏做法有了一个很好的了解。

Answer 5

有对Microsoft编码标准的引用。 Visual Studio 2005和2008内置了一个代码分析引擎，它将指导您完成这些编码标准，并指出一些最佳实践。右键单击您的项目，然后单击“在项目上运行代码分析”。

每当发现无效或不太优选的代码部分时，它不仅会向您发出警告，而且会指向FxCop站点上的“帮助资源”。

Answer 6

MSDN：Naming Guidelines

我倾向于遵循.NET框架的编码方式，因此我的代码与.NET Framework保持一致。

我唯一的个人偏好是类变量的命名，我在每个变量之前使用前缀“m_”，如private int m_count。

Answer 7

您可以将StyleCop和FxCop（或VS2008 Pro内置代码分析）的组合用于工具和Framework Design Guidelines。

什么是C＃“格式化”标准？

7 个答案: