-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Closed
Labels
dotnet-csharp/svcfundamentals/subsvcgood first issueIssue should be good for first-time contributors, with clear instructionsIssue should be good for first-time contributors, with clear instructionshelp wantedGood for community contributors to help [up-for-grabs]Good for community contributors to help [up-for-grabs]
Description
Its worth noting AND THERE SHOULD BE EXAMPLES HERE - that <para> started being double spaced with VS2017 and continues to be doubled spaced in VS2019. Several issues were raised on MSDN about it and all were closed with no solution provided for creating single-spaced XML intellisense comments in our C# and F# code. All just say "not on our current road map".
It is now necessary to add <br/> breaks at the end of each line you want to have single spaced.
For example, if you wanted to include a single spaced block of code to your method.
/// <summary>Gets the angle (0-360, 0 being North) between two points. The angle is the direction from point 1 to point 2.
/// <code> <para>
/// GetAngle(0, 0, 1, 0) = 0<br/>
/// GetAngle(0, 0, -1, 0) = 180<br/>
/// GetAngle(0, 0, -1, 0) = 180<br/>
/// GetAngle(0, 0, 0, 1) = 90<br/>
/// GetAngle(0, 0, 0, -1) = 270<br/>
/// </para></code>
/// </summary>
/// <param name="lat1"></param>
/// <param name="long1"></param>
/// <param name="lat2"></param>
/// <param name="long2"></param>
/// <returns></returns>edit by @BillWagner: format sample.
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
- ID: 48fc95e1-59ca-895f-dc67-b7397363689a
- Version Independent ID: 8cbd9296-638d-5e83-24a6-569b497835e2
- Content: <para> - C# Programming Guide
- Content Source: docs/csharp/programming-guide/xmldoc/para.md
- Product: dotnet-csharp
- Technology: csharp-fundamentals
- GitHub Login: @BillWagner
- Microsoft Alias: wiwagn
Metadata
Metadata
Assignees
Labels
dotnet-csharp/svcfundamentals/subsvcgood first issueIssue should be good for first-time contributors, with clear instructionsIssue should be good for first-time contributors, with clear instructionshelp wantedGood for community contributors to help [up-for-grabs]Good for community contributors to help [up-for-grabs]