CodeStyleOptions Class
- Namespace
- Kampute.DocToolkit.Languages
- Assembly
Definition
Represents the options that control the behavior of the programming language models when formatting code elements.
public class CodeStyleOptions
- Inheritance
Constructors
Properties
| FullyQualifyExplicitInterfaceMemberNames | Gets or sets a value indicating whether to fully qualify explicit interface member names. |
| GlobalNameQualifier | Gets or sets the level of qualification to apply to the name of types for types of parameters, return values, extended classes, implemented interfaces, attributes, and type parameters. |
| IgnoreParameterAttributes | Gets or sets a value indicating whether to ignore the attributes applied to parameters. |
| IgnoreReturnParameterAttributes | Gets or sets a value indicating whether to ignore the attributes applied to return values. |
| IgnoreTypeAttributes | Gets or sets a value indicating whether to ignore the attributes applied to types. |
| IgnoreTypeMemberAttributes | Gets or sets a value indicating whether to ignore the attributes applied to type members. |
| IgnoreTypeParameterAttributes | Gets or sets a value indicating whether to ignore the attributes applied to generic type parameters. |
| IgnoredAttributes | Gets the collection of patterns that determine the attributes to exclude from the definition of a type or type's member. |
| MaxInlineParameters | Gets or sets the maximum number of parameters in a member definition before wrapping. |
| SimplifySystemTypeNames | Gets or sets a value indicating whether to simplify the names of system types. |
Methods
The CodeStyleOptions class provides a configurable set of formatting preferences that determine how code elements are rendered in documentation. It allows documentation authors to customize the appearance of code signatures and definitions to match their preferred style or organizational standards.
The class offers configuration options for:- Parameter formatting and wrapping behavior
- Type name simplification for system types
- Name qualification levels for different code elements
- Attribute visibility and filtering
By providing a single point of configuration, CodeStyleOptions ensures consistent formatting throughout the documentation regardless of where code elements are rendered. This consistency improves readability and maintains a professional appearance across all generated documentation.Instances of this class can be passed to implementations of IProgrammingLanguage to control their formatting behavior. The default values are chosen to provide a balance between readability and completeness in most documentation scenarios.