# ParameterExampleResult constructor

Kind: Constructor  
Namespace: `Sisk.Documenting.Content`  
Assembly: `Sisk.Documenting.dll`  
Source: https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.-ctor.html

## ParameterExampleResult(string, string, bool, string?) {#Sisk_Documenting_Content_ParameterExampleResult__ctor_System_String_System_String_System_Boolean_System_String_}

Initializes a new instance of the [ParameterExampleResult](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.md) class with the specified parameter name, type name, requirement, and description.

```csharp
public ParameterExampleResult(string parameterName, string typeName, bool isRequired, string? description)
```

### Parameters

`parameterName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the parameter.

`typeName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the parameter's type.

`isRequired` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

[`true`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the parameter is required; otherwise, [`false`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

`description` [string](https://learn.microsoft.com/dotnet/api/system.string)?

The description of the parameter, or [`null`](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if no description is provided.

## ParameterExampleResult(string, string, bool) {#Sisk_Documenting_Content_ParameterExampleResult__ctor_System_String_System_String_System_Boolean_}

Initializes a new instance of the [ParameterExampleResult](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.md) class with the specified parameter name, type name, and requirement.

```csharp
public ParameterExampleResult(string parameterName, string typeName, bool isRequired)
```

### Parameters

`parameterName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the parameter.

`typeName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the parameter's type.

`isRequired` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

[`true`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the parameter is required; otherwise, [`false`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).