pmd/docs/index.md
Andreas Dangel 70ab4f2468 Restructure pages: product is now "pmd", sidebar new, pages moved
Removed the samples mydoc, product1, product2
2017-05-25 12:16:23 +02:00

48 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: PMD Introduction
keywords: java
tags: [getting_started]
sidebar: pmd_sidebar
permalink: index.html
summary: Welcome to PMD, an OpenSource project for analyzing source code.
---
Source for this new site can be found here: https://github.com/JosephAllen/PMD-New-Site
Suggested site structure can be made here: https://github.com/JosephAllen/PMD-New-Site/wiki
Please feel free to fork thsi project and make page changes and to a pull so the updates can be merged with the currecnt content. There are a ton of template pages that will be deleted prior to deployment to the PMD project site.
![alt text](https://github.com/JosephAllen/PMD-New-Site/raw/master/images/logo/Source-Code-Analyzer-Logo-PMD.png)
# Welcome to PMD
PMD scans source code in Java and other languages and looks for potential problems like:
* 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
## Download
You can [download everything from here](https://sourceforge.net/projects/pmd/files/5.5.0/), and you can get an overview of all the rules for e.g. Java at the [rulesets index](pmd-java/rules/index.html) page.
PMD is [integrated](usage/integrations.html) with JDeveloper, Eclipse, JEdit, JBuilder, BlueJ, CodeGuide, NetBeans/Sun Java Studio Enterprise/Creator, IntelliJ IDEA, TextPad, Maven, Ant, Gel, JCreator, and Emacs.
## Release Notes
* See [Whats new in PMD 5.5.0](2016-06-25-release-notes-5-5-0.html)
* Older versions: [Old Release Notes](tag_release_notes.html)
## Future Releases
The next version of PMD will be developed in parallel with this release. We will release additional bugfix versions as needed.
A [snapshot](http://pmd.sourceforge.net/snapshot) of the web site for the new version is generated daily by our continuous integration server.
Maven packages are also generated regularly and uploaded to [Sonatypes OSS snapshot repository](https://oss.sonatype.org/content/repositories/snapshots/net/sourceforge/pmd/pmd/).
{% include links.html %}