Pharmacist 项目教程

1. 项目目录结构及介绍

Pharmacist 项目的目录结构如下：

Pharmacist/
├── src/
│   ├── Pharmacist.Core/
│   ├── Pharmacist.Generators/
│   ├── Pharmacist.MSBuild/
│   ├── Pharmacist.Tests/
│   └── Pharmacist.Tool/
├── .editorconfig
├── .gitignore
├── Directory.Build.props
├── LICENSE
├── README.md
└── Pharmacist.sln

目录结构介绍

• src/: 包含项目的所有源代码。

  • Pharmacist.Core/: 核心库，包含项目的主要逻辑和功能。
  • Pharmacist.Generators/: 代码生成器，用于生成特定代码。
  • Pharmacist.MSBuild/: MSBuild 集成，用于在构建过程中执行特定任务。
  • Pharmacist.Tests/: 单元测试项目，包含所有测试代码。
  • Pharmacist.Tool/: 命令行工具，用于执行项目相关操作。

• .editorconfig: 编辑器配置文件，用于统一代码风格。

• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。

• Directory.Build.props: MSBuild 属性文件，用于定义项目构建时的全局属性。

• LICENSE: 项目许可证文件。

• README.md: 项目说明文件，包含项目的基本信息和使用指南。

• Pharmacist.sln: Visual Studio 解决方案文件，用于管理项目。

2. 项目启动文件介绍

Pharmacist 项目的启动文件主要位于 Pharmacist.Tool 目录中。以下是启动文件的介绍：

Program.cs

// Pharmacist.Tool/Program.cs

using System;
using Pharmacist.Core;

namespace Pharmacist.Tool
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Pharmacist Tool Started");
            // 启动逻辑
            var core = new CoreLogic();
            core.Run();
        }
    }
}

启动文件介绍

• Program.cs: 这是项目的入口文件，包含了 Main 方法，用于启动应用程序。CoreLogic 类是核心逻辑的入口点，负责执行主要的业务逻辑。

3. 项目配置文件介绍

Pharmacist 项目中有几个重要的配置文件，用于定义项目的构建和运行时行为。

Directory.Build.props

<!-- Directory.Build.props -->

<Project>
  <PropertyGroup>
    <LangVersion>latest</LangVersion>
    <Nullable>enable</Nullable>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
  </PropertyGroup>
</Project>

配置文件介绍

• Directory.Build.props: 这是一个 MSBuild 属性文件，定义了项目构建时的全局属性。例如，LangVersion 指定了使用的 C# 语言版本，Nullable 启用了可空引用类型，TreatWarningsAsErrors 将警告视为错误。

.editorconfig

# .editorconfig

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.cs]
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true

配置文件介绍

• .editorconfig: 这是一个编辑器配置文件，用于统一代码风格。它定义了缩进样式、缩进大小、换行符类型等。对于 C# 文件，还定义了代码块的换行规则。

通过以上配置文件，Pharmacist 项目确保了代码风格的一致性和构建过程的规范性。