Mapperly 项目教程

Mapperly 项目教程

mapperly A .NET source generator for generating object mappings. No runtime reflection. 项目地址: https://gitcode.com/gh_mirrors/ma/mapperly

1. 项目目录结构及介绍

Mapperly 项目的目录结构如下：

mapperly/
├── benchmarks/
│   └── Riok.Mapperly.Benchmarks/
├── build/
├── docs/
├── samples/
│   └── Riok.Mapperly.Sample/
├── src/
├── test/
├── .csharpierignore
├── .csharpierrc.yaml
├── .editorconfig
├── .gitattributes
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Directory.Build.props
├── LICENSE
├── README.md
├── Riok.Mapperly.sln
└── global.json

目录介绍

• benchmarks/: 包含性能测试相关的代码。
• build/: 包含项目的构建脚本和配置文件。
• docs/: 包含项目的文档文件。
• samples/: 包含示例代码，展示如何使用 Mapperly。
• src/: 包含项目的主要源代码。
• test/: 包含项目的测试代码。
• .csharpierignore: 用于配置 CSharpier 忽略的文件。
• .csharpierrc.yaml: 用于配置 CSharpier 的规则。
• .editorconfig: 用于配置编辑器的代码风格。
• .gitattributes: 用于配置 Git 的属性。
• .gitignore: 用于配置 Git 忽略的文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目的贡献指南。
• Directory.Build.props: 项目的构建属性配置文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• Riok.Mapperly.sln: 项目的解决方案文件。
• global.json: 项目的全局配置文件。

2. 项目的启动文件介绍

Mapperly 项目的主要启动文件是 Riok.Mapperly.sln，这是一个 Visual Studio 解决方案文件。通过打开这个文件，开发者可以在 Visual Studio 中加载整个项目，并开始编写和运行代码。

3. 项目的配置文件介绍

global.json

global.json 文件用于配置项目的全局设置，例如 SDK 版本等。以下是一个示例内容：

{
  "sdk": {
    "version": "5.0.100"
  }
}

Directory.Build.props

Directory.Build.props 文件用于配置项目的构建属性。以下是一个示例内容：

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

.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

.gitignore

.gitignore 文件用于配置 Git 忽略的文件。以下是一个示例内容：

# Ignore Visual Studio temporary files, build results, and
# files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates

# Build results
[Dd]ebug/
[Rr]elease/
x64/
x86/
build/

通过这些配置文件，开发者可以自定义项目的构建和开发环境，确保代码风格一致，并忽略不必要的文件。

mapperly A .NET source generator for generating object mappings. No runtime reflection. 项目地址: https://gitcode.com/gh_mirrors/ma/mapperly