c#代码规范

简介: 举个例子public static void Test() { for (int i = 1; i < 101; i++) { if (i % 3 == 0 && i % 5 == 0) { Console.

举个例子

public static void Test()
    {
      for (int i = 1; i < 101; i++)
      {
        if (i % 3 == 0 && i % 5 == 0)
        {
          Console.WriteLine("FizzBuzz");
        }
        else if (i % 3 == 0)
        {
          Console.WriteLine("Fizz");
        }
        else if (i % 5 == 0)
        {
          Console.WriteLine("Buzz");
        }
        else
        {
          Console.WriteLine(i);
        }
      }
    }

优化后的代码

public static void Check()
    {
      for (int i = 1; i <= 100; i++)
      {
        string output = "";
        if (i % 3 == 0) { output = "Fizz"; }
        if (i % 5 == 0) { output = output + "Buzz"; }
        if (output == "") { output = i.ToString(); }
        Console.WriteLine(output);
      }
    }

两个代码的简洁程度清晰可见

好的代码应该拥有一下特征
1.代码容易编写,并易于修改和扩展。
2.代码干净,并表述准确。
3.代码有价值,并注重质量。

1.大小写规范
元素,方法的参数和局部变量的第一个单词首字母小写 后续的首字母均大写
方法的每个单词首字母都要大写

2.不要使用缩写语。

  // Correct
    ProductCategory productCategory;

    // Avoid
    ProductCategory prodCat;

3.不要在标示符中使用下划线。

    // Correct
    ProductCategory productCategory;

    // Avoid
    ProductCategory product_Category;

4要在接口名称前使用字母 I 。

    public interface IAddress
    {
    } 

5.要在类的顶端定义所有成员变量,在最顶端定义静态变量。

public class Product
  {
    public static string BrandName;

    public string Name { get; set; }
    public DateTime DateAvailable { get; set; }

    public Product()
    {
      // ...
    }
  }

编写代码应该遵循的规则

1.始终控制类的大小 就是 一个类 一个功能

2.避免不必要的Region 可以考虑将Region单独放一个类里
Region 是 Visual Studio 提供的一个功能,它允许你将代码分块。
Region 的存在是因为它可以使大文件导航变得容易。
Region 还常被用于隐藏丑陋的代码,或者类已经膨胀的非常大了需要分块。
而如果一个类做了太多的事情,也就说明其违反了单一职责原则。
所以,下次当你想新增一个 Region 时,先考虑下有没有可能将这个 Region 分离到一个单独的类中。

3.方法中的代码行数越多,则方法越难理解。我们推荐每个方法中只包含 20-25 行代码。

4.通过声明一个类来代替多个参数。创建一个类,用于包含所有的参数。
通常来讲,这是一个较好的设计,并且这个抽象非常的有价值。

5.精简多处返回 避免一个方法里面多个返回
在每段程序中都减少函数返回的数量。
假设从底部开始阅读代码,你很难意识到有可能在上面的某处已经返回了,
这样的代码将是非常难理解的。
仅使用一处返回可以增强可读性。
如果程序这么写的话可能看起来比较干净,但不立即返回也意味着需要编写更多代码。

 var isValid = true;
      if(product.Price>15)
      {
         isValid= false;
      }
      else if(product.IsDeleted)
      {
         isValid= false;
      }
      else if(!product.IsFeatured)
      {
         isValid= false;
      }
      return isValid;

 ```
而不是

if(product.Price>15)
{
return false;
}
else if(product.IsDeleted)
{
return false;
}
else if(!product.IsFeatured)
{
return false;
}
else if()
{
//…..
}
return true;
“`

目录
相关文章
|
XML 算法 安全
C#编码规范
本篇内容记录了 命名惯例和规范、 ** 良好的编程习惯、** 注释 、 ** 异常处理
558 0
C#编码规范
|
2月前
|
程序员 测试技术
程序员的代码规范需求
程序员的代码规范需求
33 0
|
5月前
|
SQL 存储 安全
代码规范(如何提高代码规范)
在软件开发中,优雅的代码规范对于编写美观且实用的代码至关重要。以下是一些提升代码质量的建议: 1. **命名清晰**:使用描述性强的命名,使代码自解释,减少误解,提高可读性。 2. **简洁性**:用最少的代码实现功能,避免冗余,简洁的代码更易维护。 3. **一致性**:保持命名和编码风格的一致性,降低团队协作成本。 4. **注释**:合理注释解释代码意图,但避免过度注释。 5. **避免复杂性**:将复杂逻辑分解为简单部分,用函数或模块封装。 6. **重构**:定期重构代码以提高可读性和性能。 7. **测试**:编写单元测试确保代码的稳定性和可靠性。
|
5月前
|
数据库
代码规范(一)
代码规范(一)
56 0
|
C语言
代码规范要求
代码规范要求
160 0
|
JSON 前端开发 JavaScript
规范(一):代码规范
规范(一):代码规范
规范(一):代码规范
|
移动开发 前端开发 JavaScript