Jump to content

StyleCop: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
Cangaran (talk | contribs)
Added links
Tags: Mobile edit Mobile app edit
new version, developer. compatibility of previous and latest version, and successor.
Line 2: Line 2:
| name = StyleCop
| name = StyleCop
| author = Microsoft
| author = Microsoft
| developer = andyr
| developer = Chris Dahlberg
| latest release version = 4.7.55
| latest release version = 5.0.6329.1
| latest release date = {{Start date and age|2016|11|10}}
| latest release date = {{Start date and age|2017|04|30}}
| status = Active
| status = Active
| license = Microsoft Public Licence
| license = Microsoft Public Licence
| website = {{URL|github.com/StyleCop}}
| website = {{URL|https://github.com/StyleCop}}
}}
}}
'''StyleCop''' is an [[open source]] [[static code analysis]] tool from [[Microsoft]]<ref>{{Cite web|url=https://blogs.msdn.microsoft.com/sourceanalysis/2008/05/25/a-brief-history-of-c-style/|title=A Brief History Of C# Style|access-date=2016-07-19}}</ref> that checks [[C Sharp (programming language)|C#]] code for conformance to StyleCop's recommended coding styles and a subset of Microsoft's .NET Framework Design Guidelines. StyleCop analyses the [[source code]], allowing it to enforce a different set of rules from [[FxCop]] (which, instead of source code, checks [[.NET Framework|.NET]] [[managed code]] [[Assembly (CLI)|assemblies]]).<ref>{{cite web | url=http://www.techrepublic.com/blog/programming-and-development/maintain-code-consistency-with-microsoft-stylecop/4328 | title=Maintain code consistency with Microsoft StyleCop | publisher=TechRepublic | work=Blogs / Software Engineer | date=June 24, 2011 | accessdate=December 10, 2011 | author=Patton, Tony}}</ref><ref>{{cite web | url=http://www.serversidemagazine.com/asp-net/8-more-useful-tools-for-asp-net/ | title=8 More Useful Tools for ASP.NET | publisher=Server-Side Magazine | work=ASP .Net | date=July 30, 2009 | accessdate=December 10, 2011 | author=Chinery, Clive}}</ref> The rules are classified into the following categories:
'''StyleCop''' is an [[open source]] [[static code analysis]] tool from [[Microsoft]]<ref>{{cite web|url=https://blogs.msdn.microsoft.com/sourceanalysis/2008/05/25/a-brief-history-of-c-style/|title=A Brief History Of C# Style|access-date=2016-07-19}}</ref> that checks [[C Sharp (programming language)|C#]] code for conformance to StyleCop's recommended coding styles and a subset of Microsoft's .NET Framework Design Guidelines. StyleCop analyses the [[source code]], allowing it to enforce a different set of rules from [[FxCop]] (which, instead of source code, checks [[.NET Framework|.NET]] [[managed code]] [[assembly (CLI)|assemblies]]).<ref>{{cite web |url=http://www.techrepublic.com/blog/programming-and-development/maintain-code-consistency-with-microsoft-stylecop/4328 |title=Maintain code consistency with Microsoft StyleCop |publisher=TechRepublic |work=Blogs / Software Engineer |date=June 24, 2011 |accessdate=December 10, 2011 |author=Patton, Tony}}</ref><ref>{{cite web |url=http://www.serversidemagazine.com/asp-net/8-more-useful-tools-for-asp-net/ |title=8 More Useful Tools for ASP.NET |publisher=Server-Side Magazine |work=ASP .Net |date=July 30, 2009 |accessdate=December 10, 2011 |author=Chinery, Clive}}</ref> The rules are classified into the following categories:
* Documentation
*Documentation
* Layout
*Layout
* Maintainability
*Maintainability
* Naming
*Naming
* Ordering
*Ordering
* Readability
*Readability
* Spacing
*Spacing


StyleCop includes both [[GUI]] and command line versions of the tool. It is possible to create new rules to be used.
StyleCop includes both [[GUI]] and command-line versions of the tool. It is possible to add new rules to be applied.


StyleCop was re-released as an open source project in April 2010 on codeplex.com and has since moved to https://github.com/StyleCop .
StyleCop was re-released as an open-source project in April 2010 on [[CodePlex]].

StyleCop 4.7.55 (November 10, 2016) is compatible with Visual Studio 2008, 2010, 2012, 2013, and 2015.<ref>https://stylecop.codeplex.com/ StyleCop (old CodePlex site)</ref> (Microsoft Visual Studio Extension)

StyleCop moved to [[GitHub]].

StyleCop 5.0.6329.1 (April 30, 2017) works with Visual Studio 2012, 2013, 2015, and 2017.<ref>https://marketplace.visualstudio.com/items?itemName=ChrisDahlberg.StyleCop StyleCop - Visual Studio Marketplace</ref> (Windows Installer)

Development is stopping. A named successor is StyleCopAnalyzers, for Visual Studio 2015 and later.


==See also==
==See also==
* [[FxCop]]
*[[FxCop]]
* [[List of tools for static code analysis]]
*[[List of tools for static code analysis]]


==References==
==References==
{{reflist}}
{{Reflist}}


==External links==
==External links==
*{{Official website|https://github.com/StyleCop }}
*{{Official website|https://github.com/StyleCop }}
*[http://blogs.msdn.com/sourceanalysis Legacy Microsoft-hosted StyleCop blog]
*[http://blogs.msdn.com/sourceanalysis Legacy Microsoft-hosted StyleCop blog (2010)]


[[Category:.NET programming tools]]
[[Category:.NET programming tools]]

Revision as of 22:43, 25 July 2017

StyleCop
Original author(s)Microsoft
Developer(s)Chris Dahlberg
Stable release
5.0.6329.1 / April 30, 2017; 7 years ago (2017-04-30)
LicenseMicrosoft Public Licence
Websitegithub.com/StyleCop

StyleCop is an open source static code analysis tool from Microsoft[1] that checks C# code for conformance to StyleCop's recommended coding styles and a subset of Microsoft's .NET Framework Design Guidelines. StyleCop analyses the source code, allowing it to enforce a different set of rules from FxCop (which, instead of source code, checks .NET managed code assemblies).[2][3] The rules are classified into the following categories:

  • Documentation
  • Layout
  • Maintainability
  • Naming
  • Ordering
  • Readability
  • Spacing

StyleCop includes both GUI and command-line versions of the tool. It is possible to add new rules to be applied.

StyleCop was re-released as an open-source project in April 2010 on CodePlex.

StyleCop 4.7.55 (November 10, 2016) is compatible with Visual Studio 2008, 2010, 2012, 2013, and 2015.[4] (Microsoft Visual Studio Extension)

StyleCop moved to GitHub.

StyleCop 5.0.6329.1 (April 30, 2017) works with Visual Studio 2012, 2013, 2015, and 2017.[5] (Windows Installer)

Development is stopping. A named successor is StyleCopAnalyzers, for Visual Studio 2015 and later.

See also

References

  1. ^ "A Brief History Of C# Style". Retrieved 2016-07-19.
  2. ^ Patton, Tony (June 24, 2011). "Maintain code consistency with Microsoft StyleCop". Blogs / Software Engineer. TechRepublic. Retrieved December 10, 2011.
  3. ^ Chinery, Clive (July 30, 2009). "8 More Useful Tools for ASP.NET". ASP .Net. Server-Side Magazine. Retrieved December 10, 2011.
  4. ^ https://stylecop.codeplex.com/ StyleCop (old CodePlex site)
  5. ^ https://marketplace.visualstudio.com/items?itemName=ChrisDahlberg.StyleCop StyleCop - Visual Studio Marketplace