How to get SA1632 violation?

May 26, 2011 at 10:14 PM

What code should report SA1632 violation? I need this as test code, but I can't get any working sample. Anyone?

Regards

May 30, 2011 at 10:56 PM

Are you sure you mean SA1632? SA1632 says: "The documentation text within the summary tag must be at least 10 characters in length or at least 2 words. Documentation failing to meet this guideline most likely does not follow a proper grammatical structure required for documentation text.".

Example:

/// <summary>foo</summary>
class Foo
{
}

Jun 1, 2011 at 9:59 PM

Yes, I'm sure. There were some changes to this rule in SC 4.5. Currently even comment such as:

<summary>A b.</summary>

does not trigger SA1632. I smell a bug here.

Coordinator
Jun 2, 2011 at 11:54 AM

Hi, Since changeset '(2658fd6a2891) fix for 6954. Updated tests. SA1632 now not thrown.' rule SA1632 is now no longer thrown at all and is deprecated. The rule that applies here now is must contain whitespace ie. at least 2 words, so "An Id" is fine. I'll update the docs.

Jun 8, 2011 at 9:11 PM

Hi Andy,

Have you considered to disable SA1632 by default, similar to SA1628 and SA1629? I think this would be better than the "nuke it" option. Can you change it this way? I personally like SA1632 and don't value such cryptic "An id" doc. Disabling this rule by default would satisfy those who don't like it. Others, including me, could then enable this rule back.

Regards

Coordinator
Jun 8, 2011 at 10:13 PM
Edited Jun 9, 2011 at 4:01 PM
I'll take a look.
A.


Coordinator
Jun 9, 2011 at 4:01 PM

Put SA1632 back in from 4.5.19.

Disabled by default.

Jun 10, 2011 at 9:53 PM

Thanks Andy for the fix. Greatly appreciated.