PlantUmlClassDiagramGenerator 项目常见问题解决方案

PlantUmlClassDiagramGenerator 项目常见问题解决方案

项目基础介绍

PlantUmlClassDiagramGenerator 是一个开源项目，旨在从 C# 源代码生成 PlantUML 类图。该项目利用 Roslyn 源代码生成器自动生成类图，适用于需要快速生成类图的开发场景。

新手使用注意事项及解决方案

1. 安装 .NET SDK 版本问题

问题描述：新手在安装项目依赖时，可能会遇到 .NET SDK 版本不兼容的问题。

解决步骤：

1. 确保安装了 .NET 8.0 SDK 或更新版本。
2. 在终端中运行以下命令安装工具：

   dotnet tool install --global PlantUmlClassDiagramGenerator
   

3. 如果遇到版本不兼容的错误，请检查系统中已安装的 .NET SDK 版本，并确保安装了符合要求的版本。

2. 生成类图时路径设置错误

问题描述：新手在使用 puml-gen 命令时，可能会错误地设置输入或输出路径，导致生成失败。

解决步骤：

1. 确保输入路径（InputPath）和输出路径（OutputPath）设置正确。
2. 使用 -dir 选项时，确保输入和输出路径均为目录。
3. 示例命令：

   puml-gen InputPath [OutputPath] [-dir]
   

4. 如果路径设置错误，请检查路径是否存在，并确保路径格式正确。

3. 忽略特定访问修饰符的问题

问题描述：新手在生成类图时，可能希望忽略某些访问修饰符的成员，但不知道如何设置。

解决步骤：

1. 使用 -ignore 选项指定要忽略的访问修饰符，多个修饰符用逗号分隔。
2. 示例命令：

   puml-gen InputPath [OutputPath] -ignore private,internal
   

3. 如果需要忽略多个访问修饰符，请确保逗号之间没有空格。

通过以上步骤，新手可以更好地理解和使用 PlantUmlClassDiagramGenerator 项目，避免常见问题。