BufTools.ObjectCreation.FromXmlComments 1.0.0

Prefix Reserved
.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package BufTools.ObjectCreation.FromXmlComments --version 1.0.0                

                    
                

            
NuGet\Install-Package BufTools.ObjectCreation.FromXmlComments -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BufTools.ObjectCreation.FromXmlComments" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add BufTools.ObjectCreation.FromXmlComments --version 1.0.0                

                    
                

            
#r "nuget: BufTools.ObjectCreation.FromXmlComments, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install BufTools.ObjectCreation.FromXmlComments as a Cake Addin
#addin nuget:?package=BufTools.ObjectCreation.FromXmlComments&version=1.0.0

// Install BufTools.ObjectCreation.FromXmlComments as a Cake Tool
#tool nuget:?package=BufTools.ObjectCreation.FromXmlComments&version=1.0.0

Object Mother

This repo provides an ObjectMother class will create an instance of an object and initialize it from the example values in your XML comments.

example:

public class ExampleModel
{
	/// <summary>
	/// An example of a string property
	/// </summary>
	/// <example>A String!</example>
	public string StringProperty { get; set; }
}

var instance = objectMother.Birth<ExampleModel>();
  • Results in truth (instance.StringProperty == "A String!")

Getting Started

  1. The ObjectMother uses an IServiceProvider to create an instance of a class. If dependency injection is not available and/or an existing IServiceProvider is not available, one can be constructed like this:
var sc = new ServiceCollection();
sc.AddSingleton<ExampleModel>();
var provider = sc.BuildServiceProvider();
  • BuildServiceProvider is located in the Microsoft.Extensions.DependencyInjection nuget package
  1. If not using DependencyInjection, then create an ObjectMother instance:
var mother = new ObjectMother(provider);
  1. Use the instance to create an object:
var instance = _target.Birth<ExampleModel>();
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on BufTools.ObjectCreation.FromXmlComments:

Package Downloads
BufTools.FluentValidation.TestByExample

Allows testing validators using example values found in the XML

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 105 5/8/2024
2.0.0 143 5/7/2024
1.1.0 281 1/26/2023
1.0.0 265 1/23/2023