ExceptionalReSharper 的项目扩展与二次开发

1. 项目的基础介绍

ExceptionalReSharper 是一个为 ReSharper 提供的开源扩展，它专注于分析和优化 C# 代码中的异常处理。该扩展通过静态分析，检查代码中抛出和记录的异常，并提供改进建议。它可以帮助开发者发现未记录或未捕获的异常，以及不符合最佳实践的异常处理代码，从而提升代码质量和项目的稳定性。

2. 项目的核心功能

• 异常未记录或未捕获警告：对于方法或属性外部抛出的异常，如果未在方法的 XML 文档中记录，或者未在代码中进行捕获，ExceptionalReSharper 会给出警告。
• 文档异常与实际抛出异常不一致：如果方法的 XML 文档中记录了某些异常，但实际上方法并未抛出这些异常，扩展将提示移除这些不必要的文档。
• 避免使用 catch-all 捕获：建议开发者避免使用通用的 catch-all 捕获块，而是针对具体的异常类型进行处理。
• 异常构造时不包含内部异常：当在 catch 块中抛出新的异常时，提醒开发者包含原始异常作为内部异常。
• 避免抛出 System.Exception：建议不要抛出基异常 System.Exception，而是使用更具体的异常类型。

3. 项目使用了哪些框架或库？

ExceptionalReSharper 主要是基于 ReSharper 的插件开发框架构建的。它使用了 ReSharper 的插件API，并且依赖于 .NET 编程环境。

4. 项目的代码目录及介绍

项目的代码目录结构如下：

• src/：包含项目的源代码。
  • ExceptionalReSharper.Core/：核心逻辑代码。
  • ExceptionalReSharper Simpsons/：示例代码，用于展示如何使用核心库。
• assets/：可能包含一些资源文件，如图片、样式表等。
• build/：构建脚本和配置文件。
• .git/：版本控制相关文件，用于自动化测试、构建等。
• docs/：项目文档，可能包含开发指南和用户手册。
• tests/：单元测试代码。

5. 对项目进行扩展或者二次开发的方向

• 增强分析功能：可以添加新的异常处理模式分析，如检测异常处理的一致性，或者分析异常处理流程中的潜在性能问题。
• 自定义规则：扩展自定义规则，允许用户根据自己的项目需求添加特定的异常处理规则。
• 集成其他工具：将 ExceptionalReSharper 的分析与代码质量工具（如 SonarQube）集成，实现更全面的代码质量分析。
• 增加可视化：为分析结果增加图表或仪表板，帮助开发者更直观地理解异常处理的状况。
• 国际化：扩展项目以支持更多语言，使其在全球范围内更具有可用性。