Header Creation

[stylecop]

Header Creation

[meh-uk]

I've seen that too actually. Very annoying.

[citizenmatt]

What are you expecting to see? Any chance you could attach (or gist) the settings?

[mayermart]

I expect to see nothing, but i see:
// --------------------------------------------------------------------------------------------------------------------
//
//
//
// --------------------------------------------------------------------------------------------------------------------

Settings: https://gist.github.com/mayermart/5d054d1d2fbd72ac2d5a

[DevHim]

I have the same problem, this is how the settings file look:

After running code-cleanup (where Stylecop rules are enabled) I get this, which I do not want:

Are we missing some setting, or what?

[jplopes]

I also noticed that having this in the File Header Text configuration:

--------------------------------------------------------------------------------------------------------------------
<copyright file="$FILENAME$" company="CompanyName">
    Copyright (c) CompanyName. All rights reserved.
</copyright>
<summary>
</summary>
--------------------------------------------------------------------------------------------------------------------

when I run a cleanup i was expecting to see this:

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ClassName.cs" company="CompanyName">
//   Copyright (c) CompanyName. All rights reserved.
// </copyright>
// <summary>
//   The ClassName.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

instead I got this:

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ClassName.cs" company="">
// 
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

Thank you.

[citizenmatt]

@jplopes Do you have a config that can replicate this? I've found an issue where the plugin wasn't reading the settings files correctly, and I suspect it's fixed the issue, but it would be nice to test.

[jplopes]

Hope this helps:
Settings.StyleCop.txt
Thank you!

[citizenmatt]

Is that the right settings file? The CompanyName and Copyright StringProperty elements are in the wrong place - they should be in the AnalyzerSettings element of the DocumentationRules section. If I move them (and I'm working with my fixed-reading-settings version) they appear as expected.

However, the summary doesn't appear, because by default, the FileHeaderMustHaveSummary rule is disabled, and you're not overriding it in your settings file. Also, there isn't any file header text configuration template like you listed.

[jplopes]

Hi again,
Sorry, I did a really bad job at explaining myself.
The File Header Text configuration I was referring to is in Resharper->Options->Code Editing->File Header Text. I was hoping that having this filled in would override StyleCop Settings (if it makes any sense). Anyway, from what I now understand from your explanation, my settings where all wrong for what I was expecting to get. Sorry for wasting your time. Keep up the awesome work you've been doing with the "million" Resharper plugins you maintain. Thank you.

[citizenmatt]

Hmm. Yeah, I need to think about the overlap between ReSharper's file header and StyleCop. The current implementation kind of ignores this, but we'd get different results if the settings came from ReSharper rather than settings.stylecop. I'll open a new issue. Cheers! 👍