C# 开发中一些好习惯

当前位置：点晴教程→知识管理交流 →『技术文档交流』

admin

2025年7月25日 12:54 本文热度 116

　引言　　　　

在 C# 编码过程中，养成一些良好的习惯能显著提升代码的可读性、可维护性和开发效率。

　清晰的命名约定　　　　

变量和方法命名：确保变量、方法、类和属性的命名具有描述性，能清晰表达其作用。

例如：CalculateTotalAmount() 比 CalcTotAmt() 更易懂。

避免使用缩写：除非是常见的缩写（如 ID），否则尽量避免缩写，因为它们不易理解。

　尽量使用 var，但不滥用　　　　

当类型可以通过上下文推断时，使用 var 可以减少冗长的类型声明

示例：

var items = db.Queryable<Book>().ToList(); // 推荐

但对于类型不明确的情况，还是使用明确类型，避免代码不易阅读：

List<Book> items = db.Queryable<Book>().ToList(); // 不推荐使用 var

　使用 async 和 await 处理异步操作　　　　

异步操作要避免阻塞 UI 线程和不必要的性能损失。

例如：

public async Task<List<Book>> GetBooksAsync(){    return await db.Queryable<Book>().ToListAsync(); }

　避免硬编码，使用常量和枚举　　　　

使用常量和枚举代替魔法数字和字符串。

public const int IsEnabled = 1;  // 定义常量public enum OrderType { 普通订单 = 0, 高级订单 = 1 }// 使用db.Queryable<Book>().Where(it => it.IsEnabled == IsEnabled);

　适当的错误处理　　　　

使用 try-catch 块处理可能的异常，避免程序崩溃。并确保捕获的异常有意义，避免空捕获。

try{    var result = db.Queryable<Book>().ToList();}catch (Exception ex){    // 记录错误日志，避免空捕获    Console.Error.WriteLine(ex.Message);    throw;}

　注释和文档化　　　

为复杂的代码块添加必要的注释。C# 提供了 XML 文档注释，可以在方法和类上使用。

/// <summary>/// 计算总金额/// </summary>/// <param name="amount">单价</param>/// <param name="quantity">数量</param>/// <returns>总金额</returns>public decimal CalculateTotalAmount(decimal amount, int quantity){    return amount * quantity;}

　尽量减少层级嵌套　　　

使用早期返回（early return）减少嵌套。

public void ProcessBook(Book book){    if (book == null) return; // 避免深层嵌套
    if (book.IsEnabled == 0) return;
    // 处理业务逻辑}

阅读原文：原文链接

该文章在 2025/7/25 14:57:15 编辑过

关键字查询

开发

正在查询...

点晴ERP是一款针对中小制造业的专业生产管理软件系统,系统成熟度和易用性得到了国内大量中小企业的青睐。

点晴PMS码头管理系统主要针对港口码头集装箱与散货日常运作、调度、堆场、车队、财务费用、相关报表等业务管理，结合码头的业务特点，围绕调度、堆场作业而开发的。集技术的先进性、管理的有效性于一体，是物流码头及其他港口类企业的高效ERP管理信息系统。

点晴WMS仓储管理系统提供了货物产品管理,销售管理,采购管理,仓储管理,仓库管理,保质期管理,货位管理,库位管理,生产管理,WMS管理系统,标签打印,条形码,二维码管理,批号管理软件。

点晴免费OA是一款软件和通用服务都免费，不限功能、不限时间、不限用户的免费OA协同办公管理系统。