Browse Source

feat(docs): 添加Core模块文档

pull/1049/head
feijie 1 year ago
parent
commit
089a197a9e
  1. 46
      aspnet-core/framework/common/LINGYUN.Abp.Core/README.EN.md
  2. 46
      aspnet-core/framework/common/LINGYUN.Abp.Core/README.md

46
aspnet-core/framework/common/LINGYUN.Abp.Core/README.EN.md

@ -0,0 +1,46 @@
# LINGYUN.Abp.Core
## Introduction
`LINGYUN.Abp.Core` is a basic core module that provides some common functionalities and extensions.
## Features
* Dynamic Options Provider (`DynamicOptionsProvider<TValue>`)
* Simplifies the complex steps of calling interfaces before using configuration
* Supports lazy loading of configuration values
* Provides one-time running mechanism to ensure configuration is loaded only once
## Installation
```bash
dotnet add package LINGYUN.Abp.Core
```
## Usage
1. Add `[DependsOn(typeof(AbpCommonModule))]` to your module class.
```csharp
[DependsOn(typeof(AbpCommonModule))]
public class YourModule : AbpModule
{
// ...
}
```
2. Use Dynamic Options Provider:
```csharp
public class YourOptionsProvider : DynamicOptionsProvider<YourOptions>
{
public YourOptionsProvider(IOptions<YourOptions> options)
: base(options)
{
}
}
```
## Links
* [中文文档](./README.md)

46
aspnet-core/framework/common/LINGYUN.Abp.Core/README.md

@ -0,0 +1,46 @@
# LINGYUN.Abp.Core
## 介绍
`LINGYUN.Abp.Core` 是一个基础核心模块,提供了一些通用的功能和扩展。
## 功能
* 动态选项提供者 (`DynamicOptionsProvider<TValue>`)
* 简化需要在使用配置前自行调用接口的繁复步骤
* 支持延迟加载配置值
* 提供一次性运行机制,确保配置只被加载一次
## 安装
```bash
dotnet add package LINGYUN.Abp.Core
```
## 使用
1. 添加 `[DependsOn(typeof(AbpCommonModule))]` 到你的模块类上。
```csharp
[DependsOn(typeof(AbpCommonModule))]
public class YourModule : AbpModule
{
// ...
}
```
2. 使用动态选项提供者:
```csharp
public class YourOptionsProvider : DynamicOptionsProvider<YourOptions>
{
public YourOptionsProvider(IOptions<YourOptions> options)
: base(options)
{
}
}
```
## 链接
* [English document](./README.EN.md)
Loading…
Cancel
Save