pmd/docs/index.md

40 lines
1.6 KiB
Markdown
Raw Normal View History

2016-09-07 16:10:48 -04:00
---
2016-09-07 22:17:39 -04:00
title: PMD Introduction
keywords: java
2016-09-07 16:10:48 -04:00
tags: [getting_started]
sidebar: pmd_sidebar
2016-09-07 16:10:48 -04:00
permalink: index.html
summary: Welcome to PMD, an extensible cross-language static code analyzer.
2016-09-07 16:10:48 -04:00
---
2017-05-25 12:35:02 +02:00
![PMD Logo](images/pmd-logo-big.png)
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
# Welcome to PMD
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
PMD scans source code in Java and other languages and looks for potential problems like:
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
* Possible bugs - empty try/catch/finally/switch statements
* Dead code - unused local variables, parameters and private methods
* Suboptimal code - wasteful String/StringBuffer usage
* Overcomplicated expressions - unnecessary if statements, for loops that could be while loops
* Duplicate code - copied/pasted code means copied/pasted bugs
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
## Download
2016-09-07 16:10:48 -04:00
You can [download everything from here](https://github.com/pmd/pmd/releases).
2016-09-07 16:10:48 -04:00
You can get an overview of all the rules for e.g. Java at the [rulesets index](pmd_rules_java.html) page.
2016-09-07 16:10:48 -04:00
2017-07-22 12:03:16 +02:00
PMD is [integrated](pmd_userdocs_tools.html) with JDeveloper, Eclipse, JEdit, JBuilder, BlueJ, CodeGuide, NetBeans/Sun Java Studio Enterprise/Creator, IntelliJ IDEA, TextPad, Maven, Ant, Gel, JCreator, and Emacs.
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
## Future Releases
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
The next version of PMD will be developed in parallel with this release. We will release additional bugfix versions as needed.
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
A [snapshot](http://pmd.sourceforge.net/snapshot) of the web site for the new version is generated daily by our continuous integration server.
2016-09-07 16:10:48 -04:00
2016-09-07 22:17:39 -04:00
Maven packages are also generated regularly and uploaded to [Sonatypes OSS snapshot repository](https://oss.sonatype.org/content/repositories/snapshots/net/sourceforge/pmd/pmd/).
2016-09-07 16:10:48 -04:00
{% include links.html %}