This section discusses formatting expressions of different kinds. ✔️ A good comment.įor formatting XML doc comments, see 'Formatting declarations' below. They are useful when eliding code sections.Ĭomments should capitalize the first letter and be well-formed phrases or sentences. to express written ideas on multiple lines.īlock comments can be used, but use sparingly. Prefer this style of comments when you want Prefer multiple double-slash comments over block comments. There's less width left for the actual codeĪvoid extraneous white space in F# code, except where described in this style guide.Important code is moved far to the right.The primary reasons for avoiding this are: Match someVeryLongExpressionWithManyParameters Match someVeryLongExpressionWithManyParameters parameter1 Seek to avoid indentation and alignment that is sensitive to naming: // ✔️ OK Avoid formatting that is sensitive to name length Choose a generally accepted style of indentation and use it systematically throughout your codebase. Variations are OK, but the first rule you should follow is consistency of indentation. That said, indentation of programs is a subjective matter. We recommend four spaces per indentation. Your organization can create coding standards to specify the number of spaces to use for indentation two, three, or four spaces of indentation at each level where indentation occurs is typical. When indenting, at least one space is required. F# code doesn't use tabs, and the compiler will give an error if a tab character is encountered outsideĪ string literal or comment. When indentation is required, you must use spaces, not tabs. The following guidelines are intended to provide guidance as to how to juggle some challenges this can impose. General rules for formattingį# uses significant white space by default and is white space sensitive.

Of an agreed settings file for the code formatter checked into the team repository. Within F# teams, code formatting specifications should be agreed and codified in terms We strongly recommend the use of this code formatter. The Fantomas code formatter is the F# community standard tool for automatic code formatting. See also Coding conventions and Component design guidelines, which also covers naming conventions. In accordance with conventions applied by formatting tools in Visual Studio Code and other editors.

This article offers guidelines for how to format your code so that your F# code is:

Visual studio code format 2 spaces