StyleCop XML Documentation Header - Using 3 /// instead of 2 //

Posted by Adam Jenkin on Stack Overflow See other posts from Stack Overflow or by Adam Jenkin
Published on 2010-03-17T16:06:51Z Indexed on 2010/03/17 16:11 UTC
Read the original article Hit count: 861

Filed under:

stylecop

|

coding-style

|

c#

|

.NET

|

coding-guidelines

I am using XML documentation headers on my c# files to pass the StyleCop rule SA1633.

Currently, I have to use the 2 slash commenting rule to allow StyleCop to recognize the header. for example:

// <copyright file="abc.ascx.cs" company="MyCompany.com">
//     MyCompany.com. All rights reserved.
// </copyright>
// <author>Me</author>

This works fine for StyleCop, however I would like to use the 3 slash commenting rule to enable visual studio to understand the comments as XML and provide the XML functionality (highlighting, auto indenting etc)

/// <copyright file="abc.ascx.cs" company="MyCompany.com">
///     MyCompany.com. All rights reserved.
/// </copyright>
/// <author>Me</author>

The problem is that when using 3 slashes, StyleCop no longer see's the header and throws the SA1633 warning.

Is there anyway to configure stylecop to understand the header is contained in XML using 3 slashes?

Thanks,

Adam

© Stack Overflow or respective owner

Related posts about stylecop

Best way to integrate StyleCop with TFS CI

as seen on Stack Overflow - Search for 'Stack Overflow'
I've been doing research on how to enable source analysis for the project I'm working on and plan to use StyleCop. The setup I have is a TFS Server for source control, using TFS Continuous Integration. I want to enable source analysis for CI builds and daily builds run on the build machine, and not… >>> More
StyleCop XML Documentation Header - Using 3 /// instead of 2 //

as seen on Stack Overflow - Search for 'Stack Overflow'
I am using XML documentation headers on my c# files to pass the StyleCop rule SA1633. Currently, I have to use the 2 slash commenting rule to allow StyleCop to recognize the header. for example: // <copyright file="abc.ascx.cs" company="MyCompany.com"> // MyCompany.com. All rights reserved… >>> More
Integrate StyleCop in NAnt buildscript

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there a way to integrate StyleCop in a NAnt script such that the build fails if there are too many style violations? There doesn't seem to be a NAnt task for StyleCop, but we've found StyleCopCmd. However this only seems to generate an XML file as output that we'd have to parse. Is there some… >>> More
StyleCop SA1124 DoNotUseRegions is reasonable?

as seen on Stack Overflow - Search for 'Stack Overflow'
SA1124 DoNotUseRegions suggest that region should not be used anywhere. Is it really reasonable? I think region is a way to group relative code together and make large class easy to read, for example, if you generate interface method in for class, a region will be automatically inserted by visual… >>> More
Visual Studio 2013 Static Code Analysis in depth: What? When and How?

as seen on ASP.net Weblogs - Search for 'ASP.net Weblogs'
In this post I'll illustrate in details the following points What is static code analysis? When to use? Supported platforms Supported Visual Studio versions How to use Run Code Analysis Manually Run Code Analysis Automatically Run Code Analysis while check-in source… >>> More

Related posts about coding-style

Which coding style is more common?

as seen on Stack Overflow - Search for 'Stack Overflow'
In no way shape or form am i advertising/promoting my programming style, but as far as 'multiple variable declarations' are concerned, which case is more acceptable professionally and commonly: case 1: private $databaseURL = "localhost" ; private $databaseUName = "root" ; private $databasePWord… >>> More
Is my javascript coding style following best-practice?

as seen on Stack Overflow - Search for 'Stack Overflow'
What is the 'best practise' with regard to coding style. Should I use _ for private members? Should I use this._privateMember? Please re-write my code in proper style if its wrong: (function()){ var _blah = 1; someFunction = function() { alert(_blah); }; someOtherFunction… >>> More
Java coding style

as seen on Stack Overflow - Search for 'Stack Overflow'
How do you keep yourself coding to standards? There is stylecop and resharper for C#. Are there any tools/eclipse plugins for code analisys in Java? Which of them do you use? >>> More
Common coding style for Python?

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I'm pretty new to Python, and I want to develop my first serious open source project. I want to ask what is the common coding style for python projects. I'll put also what I'm doing right now. 1.- What is the most widely used column width? (the eternal question) I'm currently sticking to 80… >>> More
Have you changed your coding style recently? It wasn't hard wasn't it?

as seen on Programmers - Search for 'Programmers'
I've used to write code in C-like languages using the Allman style, regarding the position of braces. void foo(int bar) { if(bar) { //... } else return; //... } Now the last two years I have been working mostly in JavaScript and when we adopted jslint as part of our QA process… >>> More