Create a well-formed XML file in C# documents to avoid complier warning and error

[BethanyZhou]

Create a well-formed XML file in C# documents to avoid complier warning and error

If we want to add description in docs for modules' properties and methods, we need generate a well-formed XML file per dll file and provide them to docs team.

There are few issues in our current c# code detected by referring https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags.

• Bad format: Correct bad format in XML comments #937
• Existing bugs: Correct bad format in XML comments #937, Fix comments in code to generate good XML file azure-powershell#18072
• Inappropriate usage of tags, Fix inappropriate usages of xml tags in Az.Accounts azure-powershell#18117, Fix inappropriate usages of tags #939
• Some of public visible properties and methods have no comments: Suppress warning1591

Bad format

The space in tag < see> should be removed.

/// A < see cref = "global::System.Threading.Tasks.Task" /> that will be complete when validation is completed.
->
/// A <see cref = "global::System.Threading.Tasks.Task" /> that will be complete when validation is completed.

Existing bugs

See #842

Inappropriate usage of tags

See #843

Many methods have no comments for them.

Error

Solution:

• Fill in the documentation comments (great, but time-consuming)
• Turn off the comment generation (in project properties)
• Disable the warning in project properties