Code reformatting, documentation

This commit is contained in:
David Kaya
2017-09-09 23:14:12 +02:00
parent b5626dadb1
commit 8fec63485d
15 changed files with 182 additions and 26 deletions

View File

@@ -1 +1,64 @@
# Dependify
# Dependify
Library that allows the developer to register his services by adding attributes to class or factory methods. Library works only with Microsoft's `Microsoft.Extensions.DependencyInjection` package.
Why the name? Because I wanted to contribute to the following [list](http://www.thenameinspector.com/wp-content/uploads/ify-names-chart-20141.pdf).
# Requirements
* `.netstandard 2.0`
* `Microsoft.Extensions.DependencyInjection`
# Usage
Let's have following interface and class
```c#
public interface ICar {
}
public class Audi : ICar {
}
```
## Class Attributes
### Single interface
If you want to add `Audi` as an implementation of `ICar` into `IServiceCollection` you just need to add `RegisterTransient`, `RegisterScoped` or `RegisterSingleton` attribute like
```c#
[RegisterTransient]
public class Audi : ICar {
}
```
and call
```c#
public void ConfigureServices(IServiceCollection services) {
services.AutoRegister();
}
```
### Multiple interfaces
If your class implements multiple interfaces, you can specify which one should be registered
```c#
[RegisterTransient(typeof(IFuelConsumer)]
public class Audi : ICar, IFuelConsumer {
}
```
## Factory method attributes
If you want to add `Audi` as an implementation of `ICar` using factory method, you can do following
```c#
[RegisterTransientFactory(typeof(ICar))]
public Audi CreateAudi(IServiceProvider provider) {
return new Audi();
}
```