Checkstyle

From Free Software Directory
Revision as of 10:24, 12 April 2011 by WikiSysop (talk | contribs)$7

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
[edit]

Checkstyle

https://github.com/checkstyle/checkstyle
Java syntax checker

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.

Checkstyle is highly configurable and can be made to support almost any coding standard. An example configuration file is supplied supporting the Sun Code Conventions. As well, other sample configuration files are supplied for other well known conventions.

Checkstyle can check many aspects of your source code. Historically it's main functionality has been to check code layout issues, but since the internal architecture was changed in version 3, more and more checks for other purposes have been added. Now Checkstyle provides checks that find class design problems, duplicate code, or bug patterns like double checked locking.

Related Projects




Licensing

LicenseVerified byVerified onNotes
LGPLv2.1Tim Musson19 March 2012
Apache2.0Tim Musson19 March 2012



Leaders and contributors

Contact(s)Role
Oliver Burn Maintainer


Resources and communication

AudienceResource typeURI
DeveloperMailing Listhttps://lists.sourceforge.net/lists/listinfo/checkstyle-devel
DeveloperMailing Listhttps://lists.sourceforge.net/lists/listinfo/checkstyle-commits
User, DeveloperBug Trackinghttp://sourceforge.net/tracker/?group_id=29721
UserMailing Listhttps://lists.sourceforge.net/lists/listinfo/checkstyle-user
User, DeveloperMailing Listhttps://lists.sourceforge.net/lists/listinfo/checkstyle-announce


Software prerequisites

KindDescription
Required to useANTLR (http://www.antlr.org)
Required to useJakarta regexp package (http://jakarta.apache.org/regexp)

This entry (in part or in whole) was last reviewed on 19 March 2012.



Entry



















Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.