Free Software Foundation!

Join now

Difference between revisions of "Checkstyle"

From Free Software Directory
Jump to: navigation,
(Created page with "{{Entry |Name=Checkstyle |Short description=Java syntax checker |Full description=Checkstyle is a development tool to help programmers write Java code that adheres to a coding st...")
 
(Entry updated)
Line 2: Line 2:
 
|Name=Checkstyle
 
|Name=Checkstyle
 
|Short description=Java syntax checker
 
|Short description=Java syntax checker
|Full description=Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. Its purpose is to automate the process of checking Java code, and to spare humans of this task. The program checks for:
+
|Full description=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 of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.
* Javadoc comments are defined for class, interface, variable and method declarations.
+
 
* Javadoc tags for a method match the actual code.
+
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.
* The file starts with a specified header. This is useful to ensure that a file has a copyright notice.
+
 
* An @author tag exists for class and interface Javadoc comments. This can be turned off.
+
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.  
* Format of variable names match specified regular
+
 
* expressions. For examp le, can enforce that all static variables must start with "s".
+
* Class/interface names format matches specified regular expressions.
+
* Format of parameter names match a specified regular expression.
+
* Variables that are not declared as private or protected.
+
* Correct use of white space around binary and unary operators. For examp le, x -=- 1; is illegal, whereas x -= -1; is not.
+
* Ensure {}'s are used for if/while/for/do constructs.
+
* Lines are not longer than a specified length.
+
* Lines do not contain tabs. Note: this check can be turned off.
+
|User level=none
+
|Status=Live
+
|Component programs=
+
 
|Homepage URL=http://checkstyle.sourceforge.net/
 
|Homepage URL=http://checkstyle.sourceforge.net/
|VCS checkout command=
+
|Is GNU=No
 +
|User level=none
 +
|VCS checkout command=hg clone http://checkstyle.hg.sourceforge.net:8000/hgroot/checkstyle/checkstyle
 
|Computer languages=Java
 
|Computer languages=Java
|Documentation note=User guide included
 
|Paid support=
 
|IRC help=
 
|IRC general=
 
|IRC development=
 
 
|Related projects=Jlint
 
|Related projects=Jlint
 
|Keywords=software development,syntax,Java,syntax checker,checkstyle
 
|Keywords=software development,syntax,Java,syntax checker,checkstyle
|Is GNU=n
+
|Version identifier=5.5
|Last review by=Janet Casey
+
|Version date=2011/11/05
|Last review date=2003-11-21
+
|Version status=stable
 +
|Version download=http://sourceforge.net/projects/checkstyle/files/checkstyle/5.5/checkstyle-5.5-src.tar.gz/download
 +
|Version comment=5.5 stable released 2011-11-05
 +
|Last review by=Tim Musson
 +
|Last review date=2012/03/19
 
|Submitted by=Database conversion
 
|Submitted by=Database conversion
 
|Submitted date=2011-04-01
 
|Submitted date=2011-04-01
|Version identifier=2.2
 
|Version date=2002-05-10
 
|Version status=stable
 
|Version download=http://www.geocities.com/oburn/checkstyle/v1_0/checkstyle-src-1.0.tar.gz
 
 
|License verified date=2001-02-21
 
|License verified date=2001-02-21
|Version comment=2.2 stable released 2002-05-10
+
}}
 +
{{Project license
 +
|License=LGPLv2.1
 +
|License verified by=Tim Musson
 +
|License verified date=2001-02-21
 +
}}
 +
{{Project license
 +
|License=Apache2.0
 +
|License verified by=Tim Musson
 +
|License verified date=2012/03/19
 
}}
 
}}
 
{{Person
 
{{Person
|Role=Maintainer
 
 
|Real name=Oliver Burn
 
|Real name=Oliver Burn
 +
|Role=Maintainer
 
|Email=checkstyle@puppycrawl.com
 
|Email=checkstyle@puppycrawl.com
|Resource URL=
 
 
}}
 
}}
 
{{Resource
 
{{Resource
|Resource audience=Bug Tracking,Developer,Support
+
|Resource audience=User
|Resource kind=E-mail
+
|Resource kind=Mailing List
|Resource URL=mailto:checkstyle@puppycrawl.com
+
|Resource URL=https://lists.sourceforge.net/lists/listinfo/checkstyle-user
 +
}}
 +
{{Resource
 +
|Resource audience=User, Developer
 +
|Resource kind=Mailing List
 +
|Resource URL=https://lists.sourceforge.net/lists/listinfo/checkstyle-announce
 +
}}
 +
{{Resource
 +
|Resource audience=Developer
 +
|Resource kind=Mailing List
 +
|Resource URL=https://lists.sourceforge.net/lists/listinfo/checkstyle-devel
 +
}}
 +
{{Resource
 +
|Resource audience=Developer
 +
|Resource kind=Mailing List
 +
|Resource URL=https://lists.sourceforge.net/lists/listinfo/checkstyle-commits
 +
}}
 +
{{Resource
 +
|Resource audience=User, Developer
 +
|Resource kind=Bug Tracking
 +
|Resource URL=http://sourceforge.net/tracker/?group_id=29721
 
}}
 
}}
 
{{Software category
 
{{Software category
Line 56: Line 70:
 
|Software-development=program-build-automation
 
|Software-development=program-build-automation
 
|Use=software-development
 
|Use=software-development
}}
 
{{Project license
 
|License=LGPL
 
|License verified by=Janet Casey
 
|License verified date=2001-02-21
 
 
}}
 
}}
 
{{Software prerequisite
 
{{Software prerequisite
Line 70: Line 79:
 
|Prerequisite description=Jakarta regexp package (http://jakarta.apache.org/regexp)
 
|Prerequisite description=Jakarta regexp package (http://jakarta.apache.org/regexp)
 
}}
 
}}
 +
{{Featured}}

Revision as of 09:50, 18 March 2012

[edit]

Checkstyle

http://checkstyle.sourceforge.net/
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

Audience Resource type URI
User Mailing List https://lists.sourceforge.net/lists/listinfo/checkstyle-user
User, Developer Mailing List https://lists.sourceforge.net/lists/listinfo/checkstyle-announce
Developer Mailing List https://lists.sourceforge.net/lists/listinfo/checkstyle-devel
Developer Mailing List https://lists.sourceforge.net/lists/listinfo/checkstyle-commits
User, Developer Bug Tracking http://sourceforge.net/tracker/?group_id=29721


Software prerequisites

Kind Description
Required to use ANTLR (http://www.antlr.org)
Required to use Jakarta 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.


Personal tools
Namespaces

Variants
Actions
Navigation
Contribute