# YamlLintCommentsOptions

Settings of the YamlLintRules.Comments rule.

Class 

`OfficeIMO.Yaml`

**Namespace**

`OfficeIMO.Yaml`

**Assembly**

`OfficeIMO.Yaml`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[YamlLintOptions.cs:199](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L199)

**Base**

`YamlLintRuleOptions`

**Modifiers**

sealed

Settings of the [YamlLintRules.Comments](/api/yaml/officeimo-yaml-yamllintrules/) rule.

## Inheritance

- [YamlLintRuleOptions](/api/yaml/officeimo-yaml-yamllintruleoptions/)
- YamlLintCommentsOptions

## Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 1

- Property [YamlLintOptions.Comments](/api/yaml/officeimo-yaml-yamllintoptions/#property-comments)

Filter members 

Show inherited

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public bool RequireStartingSpace { get; set; }` [#](#property-requirestartingspace)

[YamlLintOptions.cs:199](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L199)

Gets or sets whether the comment text must start with a space after # (##### rulers excepted). Defaults to true.

`public bool IgnoreShebangs { get; set; }` [#](#property-ignoreshebangs)

[YamlLintOptions.cs:202](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L202)

Gets or sets whether a #! line at the start of the file is exempt. Defaults to true.

`public int MinSpacesFromContent { get; set; }` [#](#property-minspacesfromcontent)

[YamlLintOptions.cs:206](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L206)

Gets or sets the fewest spaces between content and a comment on the same line; 0 turns the check off. Defaults to 2.

## Inherited Properties

`public string Id { get; }` [#](#property-id)

[YamlLintOptions.cs:87](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L87)

Inherited from [YamlLintRuleOptions](/api/yaml/officeimo-yaml-yamllintruleoptions/)

`public bool Enabled { get; set; }` [#](#property-enabled)

[YamlLintOptions.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L90)

Inherited from [YamlLintRuleOptions](/api/yaml/officeimo-yaml-yamllintruleoptions/)

`public OfficeDiagnosticSeverity Severity { get; set; }` [#](#property-severity)

[YamlLintOptions.cs:93](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Yaml/Lint/YamlLintOptions.cs#L93)

Inherited from [YamlLintRuleOptions](/api/yaml/officeimo-yaml-yamllintruleoptions/)

<!-- PowerForge markdown artifact sha256:1519129399C90C682CB240DADAD966CD16B220E6821843D657D7A5B2D34AFC90 -->
