StyleCop

Last updated
StyleCop
Original author(s) Microsoft
Developer(s) Jason Allor,
Andy Reeves,
Chris Dahlberg
Stable release
5.0.6329.1 / April 30, 2017;6 years ago (2017-04-30)
Repository github.com/StyleCop/StyleCop
Written in C#
Operating system Microsoft Windows
Platform .NET Framework
Type Static code analysis tool
License Microsoft Public Licence
Website github.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:

Contents

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

StyleCop was originally developed by Jason Allor as a Microsoft internal tool, and was released externally 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 began a move to GitHub in December 2014, [5] and the last change applied to the CodePlex edition was November 11, 2016. [6]

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

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

See also

Related Research Articles

<span class="mw-page-title-main">Microsoft XNA</span> Freeware set of tools by Microsoft

Microsoft XNA is a freeware set of tools with a managed runtime environment that Microsoft developed to facilitate video game development. XNA is based on .NET Framework, with versions that run on Windows and Xbox 360. XNA Game Studio can help develop XNA games. The XNA toolset was announced on March 24, 2004, at the Game Developers Conference in San Jose, California. A first Community Technology Preview of XNA Build was released on March 14, 2006.

ASP.NET is an open-source, server-side web-application framework designed for web development to produce dynamic web pages. It was developed by Microsoft to allow programmers to build dynamic web sites, applications and services. The name stands for Active Server Pages Network Enabled Technologies.

IronPython is an implementation of the Python programming language targeting the .NET Framework and Mono. The project is currently maintained by a group of volunteers at GitHub. It is free and open-source software, and can be implemented with Python Tools for Visual Studio, which is a free and open-source extension for Microsoft's Visual Studio IDE.

<span class="mw-page-title-main">SharpDevelop</span>

SharpDevelop is a discontinued free and open source integrated development environment (IDE) for the .NET Framework, Mono, Gtk# and Glade# platforms. It supports development in C#, Visual Basic .NET, Boo, F#, IronPython and IronRuby programming languages.

A source-code-hosting facility is a file archive and web hosting facility for source code of software, documentation, web pages, and other works, accessible either publicly or privately. They are often used by open-source software projects and other multi-developer projects to maintain revision and version history, or version control. Many repositories provide a bug tracking system, and offer release management, mailing lists, and wiki-based project documentation. Software authors generally retain their copyright when software is posted to a code hosting facilities.

FxCop is a free static code analysis tool from Microsoft that checks .NET managed code assemblies for conformance to Microsoft's .NET Framework Design Guidelines.

Sandcastle is a documentation generator from Microsoft. It automatically produces MSDN-style code documentation out of reflection information of .NET assemblies and XML documentation comments found in the source code of these assemblies. It can also be used to produce user documentation from Microsoft Assistance Markup Language (MAML) with the same look and feel as reference documentation.

The following tables list notable software packages that are nominal IDEs; standalone tools such as source-code editors and GUI builders are not included. These IDEs are listed in alphabetic order of the supported language.

Azure DevOps Server is a Microsoft product that provides version control, reporting, requirements management, project management, automated builds, testing and release management capabilities. It covers the entire application lifecycle and enables DevOps capabilities. Azure DevOps can be used as a back-end to numerous integrated development environments (IDEs) but is tailored for Microsoft Visual Studio and Eclipse on all platforms.

Text Template Transformation Toolkit is a free and open-source template-based text generation framework. T4 source files are usually denoted by the file extension ".tt".

<span class="mw-page-title-main">.NET Framework</span> Software platform developed by Microsoft

The .NET Framework is a proprietary software framework developed by Microsoft that runs primarily on Microsoft Windows. It was the predominant implementation of the Common Language Infrastructure (CLI) until being superseded by the cross-platform .NET project. It includes a large class library called Framework Class Library (FCL) and provides language interoperability across several programming languages. Programs written for .NET Framework execute in a software environment named the Common Language Runtime (CLR). The CLR is an application virtual machine that provides services such as security, memory management, and exception handling. As such, computer code written using .NET Framework is called "managed code". FCL and CLR together constitute the .NET Framework.

<span class="mw-page-title-main">XML Notepad</span> XML editor developed by Microsoft

XML Notepad is an open-source XML editor written by Chris Lovett and published by Microsoft. The editor features incremental search in both tree and text views, drag/drop support, IntelliSense, find/replace with regular expressions and XPath expressions, and support for XInclude. The editor has good performance on large XML documents and has real time XML schema validation. The editor also features an HTML viewer for displaying XSLT transformation results and a built-in XML comparison tool.

Cppcheck is a static code analysis tool for the C and C++ programming languages. It is a versatile tool that can check non-standard code. The creator and lead developer is Daniel Marjamäki.

<span class="mw-page-title-main">Roslyn (compiler)</span>

.NET Compiler Platform, also known by its codename Roslyn, is a set of open-source compilers and code analysis APIs for C# and Visual Basic (VB.NET) languages from Microsoft.

<span class="mw-page-title-main">Chromium Embedded Framework</span> Free and open-source software framework

The Chromium Embedded Framework (CEF) is an open-source software framework for embedding a Chromium web browser within another application. This enables developers to add web browsing functionality to their application, as well as the ability to use HTML, CSS, and JavaScript to create the application's user interface.

ASP.NET Core was a brand briefly used by Microsoft for the rewrite of ASP.NET. It was initially a modular framework that runs on both the full .NET Framework, on Windows, and the cross-platform .NET. However, ASP.NET Core version 3 only worked on .NET Core, dropping support of the .NET Framework.

<span class="mw-page-title-main">.NET</span> Free and open-source software platform developed by Microsoft

The .NET platform is a free and open-source, managed computer software framework for Windows, Linux, and macOS operating systems. The project is mainly developed by Microsoft employees by way of the .NET Foundation and is released under an MIT License.

Microsoft, a technology company historically known for its opposition to the open source software paradigm, turned to embrace the approach in the 2010s. From the 1970s through 2000s under CEOs Bill Gates and Steve Ballmer, Microsoft viewed the community creation and sharing of communal code, later to be known as free and open source software, as a threat to its business, and both executives spoke negatively against it. In the 2010s, as the industry turned towards cloud, embedded, and mobile computing—technologies powered by open source advances—CEO Satya Nadella led Microsoft towards open source adoption although Microsoft's traditional Windows business continued to grow throughout this period generating revenues of 26.8 billion in the third quarter of 2018, while Microsoft's Azure cloud revenues nearly doubled.

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://api.github.com/repos/StyleCop/StyleCop GitHub API response for StyleCop repository
  6. https://web.archive.org/web/20171226050423/http://stylecop.codeplex.com/SourceControl/list/changesets archive.org retrieval of StyleCop on CodePlex source history
  7. https://marketplace.visualstudio.com/items?itemName=ChrisDahlberg.StyleCop StyleCop - Visual Studio Marketplace
  8. https://github.com/StyleCop/StyleCop#considerations StyleCop repository on GitHub