C# 类库中对象的类、方法、变量案例/名称的最佳实践是什么？ [关闭]

Question

我是一些小众语言的优秀开发人员，并且正在有机地学习 C#，因此尝试了解最佳实践。

我能否获得一些关于以下示例代码块最适合我构建 Shopify 集成的反馈。

namespace WMShopify
{
    // Is it common to have the namespace and class the same?
    public class WMShopify
    {
        // Are there different practices for private/public vars?
        public string APIKey { get; set; } // Capital
        public string password { get; set; } // lower case
        public string secretString { get; set; } // Camel
        private string _combinedVar; // Camel/underscore for private
    }

    // Should these be in a separate *.cs file?
    public class WMShopifyOrders
    {
        // Method capital/lower/camel?
        public int getOrderCount()
        {
            // lower/capital/camel?
            int localMemberVar = 0;

            return localMemberVar;
        }
    }

    // Should these be in a separate *.cs file?
    public class WMShopifyProducts
    {
        public List<string> getProductList()
        {
            return new List<string>();
        }
    }
}

Answer 1

最佳实践：提出一个所有人都同意并遵循的标准。

判决：书面内联

namespace WMShopify
{
    // Is it common to have the namespace and class the same?

    //No, namespace should probably be the name of the project itself.
    public class WMShopify

    //this looks like a configuration class
    {
        // Are there different practices for private/public vars?
        public string APIKey { get; set; } // Capital
        public string password { get; set; } // lower case
        public string secretString { get; set; } // Camel
        private string _combinedVar; // Camel/underscore for private
    }

    // Should these be in a separate *.cs file?
    // I like to separate them because what happens when you have 100 classes, you just scroll forever?
    public class WMShopifyOrders
    {
        // Method capital/lower/camel?
        // I prefer capital
        public int getOrderCount()
        {
            // lower/capital/camel? Sure
            int localMemberVar = 0;

            return localMemberVar;
        }
    }

    // Should these be in a separate *.cs file? Yup
    public class WMShopifyProducts
    {
        public List<string> getProductList()
        {
            return new List<string>();
        }
    }
}

Answer 2

虽然这个问题最终可能会结束，但 MSDN 确实提供了相当广泛的指导方针，大多数 .NET 开发人员在某种程度上都遵循：

https://msdn.microsoft.com/en-us/library/ms229002(v=vs.100).aspx

一些亮点：

• 不要使用缩写；如果您确实使用首字母缩略词，请仅将第一个字母大写，例如XmlReader，不是XMLReader。
• 对方法和公共字段/属性使用 PascalCase，对私有字段使用 pascalCase，对私有属性支持者使用 _camelCase。
• 将类保存在一个文件中 - 一个例外是在同一个文件中定义接口及其默认实现
• 使用动词命名方法（GetSomething()、SendSomething()，而不是 Something()）。
• 不要使用Get 或Set 命名属性，例如Things 很好但不是GetThings
• 使用“is”（IsEnabled、IsReadOnly，而不是 Enabled）命名布尔值。
• 通用参数一般应使用T，或T(description)，例如TSource, TKey, T1/T2/T3