Vannevelj / VSDiagnostics

A collection of static analyzers based on Roslyn that integrate with VS
GNU General Public License v2.0
65 stars 16 forks source link

Missing Parameter in XML doc #355

Open Hosch250 opened 8 years ago

Hosch250 commented 8 years ago
/// deserialize an array of byte arrays
/// </summary>
/// <param name="byteArray"></param>
/// <returns></returns>
public IList Deserialize(byte[][] byteArray)
{
    // ...
}

Because the summary block is messed up, this results in:

/// deserialize an array of byte arrays
/// </summary>
/// <param name="byteArray"></param>
/// <returns></returns>

/// <param name="byteArray"></param>
public IList Deserialize(byte[][] byteArray)
{
    // ...
}

At a minimum, that space shouldn't be there.

Vannevelj commented 8 years ago

I think we can benefit from an analyzer that simply checks for malformed XML documentation. Then, as a prerequisite for any other XMLDoc analyzers we can require it to be valid XMLDoc before doing any other work

Vannevelj commented 8 years ago

Oh, nevermind. I forgot that this analyzer doesn't exist yet.