Skip to content

Improve F# XML Documentation page with missing word and project file example #49031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 13, 2025
+7 −1
Merged

Improve F# XML Documentation page with missing word and project file example #49031

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2508bd7
Initial plan
Copilot Oct 8, 2025
7520875
Fix missing 'approach' word and add WarnOn project file example
Copilot Oct 8, 2025
680d291
Update docs/fsharp/language-reference/xml-documentation.md
BillWagner Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/fsharp/language-reference/xml-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ like [fsdocs](http://fsprojects.github.io/FSharp.Formatting/) to generate API re

By default, XML documentation comments are ignored by the compiler. To change this, set `--warnon:3390`. The compiler will then verify the syntax of the XML and the parameters referred to in `<param>` and `<paramref>` tags.

You can enable this warning in your project file by adding a `<WarnOn>` element to a `<PropertyGroup>` section:

```xml
<WarnOn>3390</WarnOn>
```

You can generate the XML file at compile time by doing one of the following:

- You can add a `GenerateDocumentationFile` element to the `<PropertyGroup>` section of your `.fsproj` project file,
Expand Down Expand Up @@ -49,7 +55,7 @@ The following example shows the alternative method, without XML tags. In this ex
## Comments with XML tags

If a comment body begins with `<` (normally `<summary>`), then it is treated as an XML formatted comment
body using XML tags. This second way enables you to specify separate notes
body using XML tags. This second approach enables you to specify separate notes
for a short summary, additional remarks, documentation for each parameter and type parameter and exceptions thrown, and a description of the return value.

The following is a typical XML documentation comment in a signature file:
Expand Down
Loading