nArchitecture.Gen 项目使用教程

1. 项目目录结构及介绍

nArchitecture.Gen 是一个基于 Clean Architecture 原则的项目代码生成工具。以下是项目的目录结构及各部分的简要介绍：

• .github/: 存放 GitHub Actions 工作流的配置文件，用于自动化项目的构建、测试和发布等流程。
• docs/: 包含项目的文档，如本使用教程。
• src/: 项目的核心代码目录，包含了代码生成器的实现。
• .config/: 存放项目的配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可协议文件，本项目采用 MIT 许可。
• NArchitectureCodeGenerator.sln: .NET Solution 文件，用于在 Visual Studio 中打开项目。
• README.md: 项目说明文件，介绍了项目的基本信息和如何使用。

2. 项目的启动文件介绍

项目的启动文件是 src/NArchitectureCodeGenerator/NArchitectureCodeGenerator.cs。该文件定义了代码生成器的主入口点。以下是启动文件的主要内容：

class Program
{
    static void Main(string[] args)
    {
        // 代码生成器的入口点
    }
}

在实际使用中，用户可以通过命令行工具 nArchGen 来运行代码生成器。

3. 项目的配置文件介绍

项目的配置文件主要位于 .config/ 目录下，以下是主要的配置文件及其作用：

• appsettings.json: 应用程序的默认配置文件，可以包含数据库连接字符串、API 密钥等敏感信息。
• config.json: 代码生成器特有的配置文件，定义了代码生成过程中的各种设置，如生成的代码模板、项目结构等。

配置文件的具体内容如下：

{
  "GeneratorOptions": {
    "ProjectName": "MyCleanArchitectureProject",
    "OutputPath": "./GeneratedCode",
    "Layers": [
      "Core",
      "Infrastructure",
      "Services",
      "Web"
    ],
    // 更多配置项...
  }
}

在配置文件中，用户可以自定义生成的项目名称、输出路径以及项目的分层结构等。

以上就是 nArchitecture.Gen 项目的使用教程，希望对您有所帮助。