Geeks With Blogs

News FAQ on the correct forum to post at: http://forums.asp.net/p/1337412/2699239.aspx#2699239
Tatworth

At http://stylecop.codeplex.com/discussions/257737 there is a discussion about Style Cop run SA1627 and whether blank Remarks tags should be allowed as the latest version of Style Cop (4.5.14.0) detects them.

If empty remarks XML documentation tags are wrong, then they should be deleted however I have suggested that they should not be objected to. My reasoning is that empty tags make it very easy to document comments that otherwise might be lost.

So what is your opinion in this?

Posted on Monday, May 16, 2011 11:10 AM | Back to top


Comments on this post: Style Cop Rule SA1627 (DocumentationTextMustNotBeEmpty) and Remarks Tag - Your opinion please!

No comments posted yet.
Your comment:
 (will show your gravatar)


Copyright © TATWORTH | Powered by: GeeksWithBlogs.net | Join free