Share via

FxCop 1.35 rule documentation now on MSDN Wiki [David Kean]

  • Article

One thing you might notice from today when you fire up FxCop 1.35, is that the rule URLs are now redirecting to the new MSDN Library Wiki as opposed to the old docs on GotDotNet.

To see this in action, try the following:

  1. Open FxCop 1.35
  2. Choose Windows -> Rules
  3. Expand the Naming Rules node and double-click Abstract types should not have constructors
  4. Choose the Support tab and click the URL link

The cool thing about this, is, that you can now supplement the existing docs by adding your own comments to the bottom of the topics. For example, if you have a look at the bottom of the Abstract types should not have constructors topic, you will see that I've added a Visual Basic example. While not a replacement for real documentation written by Microsoft's Programming Writers, adding your own comments helps us find out what topics need work, better samples or what topics customers are struggling with.

Note: You may notice that some topics still redirect to the old topics; this is by-design. Currently only rules that ship with Visual Studio Code Analysis have documentation on MSDN; over the coming months this will change as we work to move all the rules documentation over and document the new rules for FxCop 1.35.

Comments

  • Anonymous
    July 06, 2006
    David,

    I've opened FxCop 1.35, having just reinstalled it fresh. When I go into <b>Windows -> Rules -> <u>Design</u> Rules -> Abstract types should not have constructors -> Support -> URL</b> I am presented with the following URL:

    http://www.gotdotnet.com/team/fxcop/docs/rules.aspx?version=1.32&url=/Design/AbstractTypesShouldNotHaveConstructors.html

    I've checked the FxCop.exe.config file, and the DocumentationRoot appears to be correct (pointing at v1.35 of the documentation, which does then correctly redirect to the Wiki).

    What's wrong?

    Cheers,
    Brian

  • Anonymous
    July 07, 2006
    It appears that you are redirecting to the 1.32 version of the docs. Try the following:

    1. Start FxCop
    2. Choose Tools -> Settings
    3. Under the Use documentation from textbox, press Reset
    4. Click OK

    This should reset the url to point to 1.35.

  • Anonymous
    July 09, 2006
    Thanks David.

  • Anonymous
    September 22, 2006
    Doesn't work in Opera 9, I get a "500 Internal Server Error"

    -Frode

  • Anonymous
    September 22, 2006
    Is there anyway in 1.32 to update the documentation URL?
    1.32 is pointing to pages with no content
    http://www.gotdotnet.com/team/fxcop/docs/rules.aspx?version=1.312&&url=/Usage/MarkISerializableTypesWithSerializable.html
    Unlike 1.35 there is an obvious place in the config file we can update.
    [(davkean) We're investigating this and hopefully should have this fixed soon.]

  • Anonymous
    October 25, 2006
    At Microsoft, we have a number of internal tools and websites that help improve our interaction with