C# Class ICSharpCode.NRefactory.CSharp.FormattingOptionsFactory

The formatting options factory creates pre defined formatting option styles.
Datei anzeigen Open project: 0xd4d/NRefactory Class Usage Examples

Public Methods

Method Description
CreateAllman ( ) : CSharpFormattingOptions

Creates allman indent style CSharpFormatting options used in Visual Studio.

CreateEmpty ( ) : CSharpFormattingOptions

Creates empty CSharpFormatting options.

CreateGNU ( ) : CSharpFormattingOptions

Like the Allman and Whitesmiths styles, GNU style puts braces on a line by themselves, indented by 2 spaces, except when opening a function definition, where they are not indented. In either case, the contained code is indented by 2 spaces from the braces. Popularised by Richard Stallman, the layout may be influenced by his background of writing Lisp code. In Lisp the equivalent to a block (a progn) is a first class data entity and giving it its own indent level helps to emphasize that, whereas in C a block is just syntax. Although not directly related to indentation, GNU coding style also includes a space before the bracketed list of arguments to a function.

CreateKRStyle ( ) : CSharpFormattingOptions

The K&R style, so named because it was used in Kernighan and Ritchie's book The C Programming Language, is commonly used in C. It is less common for C++, C#, and others.

CreateMono ( ) : CSharpFormattingOptions

Creates mono indent style CSharpFormatting options.

CreateSharpDevelop ( ) : CSharpFormattingOptions

Creates sharp develop indent style CSharpFormatting options.

CreateWhitesmiths ( ) : CSharpFormattingOptions

The Whitesmiths style, also called Wishart style to a lesser extent, is less common today than the previous three. It was originally used in the documentation for the first commercial C compiler, the Whitesmiths Compiler.

Method Details

CreateAllman() public static method

Creates allman indent style CSharpFormatting options used in Visual Studio.
public static CreateAllman ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateEmpty() public static method

Creates empty CSharpFormatting options.
public static CreateEmpty ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateGNU() public static method

Like the Allman and Whitesmiths styles, GNU style puts braces on a line by themselves, indented by 2 spaces, except when opening a function definition, where they are not indented. In either case, the contained code is indented by 2 spaces from the braces. Popularised by Richard Stallman, the layout may be influenced by his background of writing Lisp code. In Lisp the equivalent to a block (a progn) is a first class data entity and giving it its own indent level helps to emphasize that, whereas in C a block is just syntax. Although not directly related to indentation, GNU coding style also includes a space before the bracketed list of arguments to a function.
public static CreateGNU ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateKRStyle() public static method

The K&R style, so named because it was used in Kernighan and Ritchie's book The C Programming Language, is commonly used in C. It is less common for C++, C#, and others.
public static CreateKRStyle ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateMono() public static method

Creates mono indent style CSharpFormatting options.
public static CreateMono ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateSharpDevelop() public static method

Creates sharp develop indent style CSharpFormatting options.
public static CreateSharpDevelop ( ) : CSharpFormattingOptions
return CSharpFormattingOptions

CreateWhitesmiths() public static method

The Whitesmiths style, also called Wishart style to a lesser extent, is less common today than the previous three. It was originally used in the documentation for the first commercial C compiler, the Whitesmiths Compiler.
public static CreateWhitesmiths ( ) : CSharpFormattingOptions
return CSharpFormattingOptions