visual studio 2010 - How to add global warning rule suppression in StyleCop.Settings file? -
i getting 5k+ stylecop warnings of different flavours. using visual studio 2010 express edition, there no menu alternative go stylecop settings or suppressions warnings within visual studio. alternative left edit stylecop.settings file attempting atm, stylecop version using 4.7.
my stylecop.settings file looks this:
<stylecopsettings version="4.3"> <globalsettings> <collectionproperty name="deprecatedwords"> <value>preprocessor,pre-processor</value> <value>shortlived,short-lived</value> </collectionproperty> </globalsettings> <parsers> <parser parserid="stylecop.csharp.csparser"> <parsersettings> <collectionproperty name="generatedfilefilters"> <value>\.g\.cs$</value> <value>\.generated\.cs$</value> <value>\.g\.i\.cs$</value> </collectionproperty> </parsersettings> </parser> </parsers> <analyzers> <analyzer analyzerid="stylecop.csharp.namingrules"> <analyzersettings> <collectionproperty name="hungarian"> <value>as</value> <value>do</value> <value>id</value> <value>if</value> <value>in</value> <value>is</value> <value>my</value> <value>no</value> <value>on</value> <value>to</value> <value>ui</value> </collectionproperty> </analyzersettings> </analyzer> </analyzers> </stylecopsettings> how need edit settings file suppress warnings within csharp.ordering , csharp.documentation, or code code (sa1202, sa1600)? don't mind solution.
sa1202 : csharp.ordering : private methods must placed after public methods. sa1600 : csharp.documentation : method must have documentation header.
solved myself, in stylecop installation folder, same folder stylecop.settings file (in case c:\program files\stylecop 4.7). there should file named stylecopsettingseditor.exe. drag , drop stylecop.settings onto stylecopsettingseditor.exe should launch application , open window shown in screenshot below.
you can edit settings grouping or specific code.
for not have ability utilize editor whatever reason, xml below shows how stylecop.settings file looks after editing.
<stylecopsettings version="105"> <globalsettings> <collectionproperty name="deprecatedwords"> <value>preprocessor,pre-processor</value> <value>shortlived,short-lived</value> </collectionproperty> </globalsettings> <parsers> <parser parserid="stylecop.csharp.csparser"> <parsersettings> <collectionproperty name="generatedfilefilters"> <value>\.g\.cs$</value> <value>\.generated\.cs$</value> <value>\.g\.i\.cs$</value> </collectionproperty> </parsersettings> </parser> </parsers> <analyzers> <analyzer analyzerid="stylecop.csharp.namingrules"> <analyzersettings> <collectionproperty name="hungarian"> <value>as</value> <value>do</value> <value>id</value> <value>if</value> <value>in</value> <value>is</value> <value>my</value> <value>no</value> <value>on</value> <value>to</value> <value>ui</value> </collectionproperty> </analyzersettings> </analyzer> <analyzer analyzerid="stylecop.csharp.documentationrules"> <rules> <rule name="elementsmustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="partialelementsmustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="enumerationitemsmustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="documentationmustcontainvalidxml"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementdocumentationmusthavesummary"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="partialelementdocumentationmusthavesummary"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementdocumentationmusthavesummarytext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="partialelementdocumentationmusthavesummarytext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementdocumentationmustnothavedefaultsummary"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementparametersmustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementparameterdocumentationmustmatchelementparameters"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementparameterdocumentationmustdeclareparametername"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementparameterdocumentationmusthavetext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementreturnvaluemustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementreturnvaluedocumentationmusthavetext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="voidreturnvaluemustnotbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="generictypeparametersmustbedocumented"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="generictypeparametersmustbedocumentedpartialclass"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="generictypeparameterdocumentationmustmatchtypeparameters"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="generictypeparameterdocumentationmustdeclareparametername"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="generictypeparameterdocumentationmusthavetext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="propertysummarydocumentationmustmatchaccessors"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="propertysummarydocumentationmustomitsetaccessorwithrestrictedaccess"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementdocumentationmustnotbecopiedandpasted"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="singlelinecommentsmustnotusedocumentationstyleslashes"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="documentationtextmustnotbeempty"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="documentationtextmustcontainwhitespace"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="documentationmustmeetcharacterpercentage"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="constructorsummarydocumentationmustbeginwithstandardtext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="destructorsummarydocumentationmustbeginwithstandardtext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="documentationheadersmustnotcontainblanklines"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="includeddocumentationxpathdoesnotexist"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="includenodedoesnotcontainvalidfileandpath"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="inheritdocmustbeusedwithinheritingclass"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementdocumentationmustbespelledcorrectly"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="filemusthaveheader"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheadermustshowcopyright"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheadermusthavecopyrighttext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheadermustcontainfilename"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheaderfilenamedocumentationmustmatchfilename"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheadermusthavevalidcompanytext"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="fileheaderfilenamedocumentationmustmatchtypename"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> </rules> <analyzersettings /> </analyzer> <analyzer analyzerid="stylecop.csharp.orderingrules"> <rules> <rule name="usingdirectivesmustbeplacedwithinnamespace"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementsmustappearinthecorrectorder"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="elementsmustbeorderedbyaccess"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="constantsmustappearbeforefields"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="staticelementsmustappearbeforeinstanceelements"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="declarationkeywordsmustfolloworder"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="protectedmustcomebeforeinternal"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="propertyaccessorsmustfolloworder"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="eventaccessorsmustfolloworder"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="staticreadonlyelementsmustappearbeforestaticnonreadonlyelements"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> <rule name="instancereadonlyelementsmustappearbeforeinstancenonreadonlyelements"> <rulesettings> <booleanproperty name="enabled">false</booleanproperty> </rulesettings> </rule> </rules> <analyzersettings /> </analyzer> </analyzers> </stylecopsettings> visual-studio-2010 configuration warnings stylecop suppress-warnings
No comments:
Post a Comment