phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Started the 'best practices' doc

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@2019 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland
2003-06-23 18:34:45 +00:00
parent 3a86736790
commit 40c4d343d8
2 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
pmd/xdocs/bestpractices.xml Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0"?>
<document>
<properties>
<author email="tom@infoether.com">Tom Copeland</author>
<title>Best Practices</title>
</properties>
<body>
<section name="Best Practices">
<subsection name="Choose the rules that are right for you">
<p>Running every ruleset will result in a huge number of rule violations, most of which will be unimportant.
Having to sort through a thousand line report to find the few you're really interested in takes
all the fun out of things.</p>
<p>Instead, start with some of the obvious rulesets - just run <a href="rules/unusedcode.html">unusedcode</a>
and fix any unused locals and fields.
Then, run <a href="rules/basic.html">basic</a> and fix all the empty <code>if</code> statements and such-like.
Then peruse the <a href="rules/basic.html">design</a> and
<a href="rules/controversial.html">controversial</a> rulesets and use the ones
you like <a href="howtomakearuleset.html">via a custom ruleset.</a></p>
</subsection>
<subsection name="PMD rules are not set in stone">
<p>TODO - generally, pick the ones you like, and ignore the warnings you don't like. It's just a tool.</p>
</subsection>
<subsection name="PMD IDE plugins are nice">
<p>Using PMD within your IDE is much more enjoyable than flipping back and forth
between an HTML report and your IDE. Most IDE plugins have the "click on the rule
violation and jump to that line of code" feature. Find the PMD plugin for your IDE, install it,
and soon you'll be fixing problems much faster.</p>
</subsection>
<p>Suggestions? Comments? Post them <a href="http://sourceforge.net/forum/forum.php?forum_id=188192">here</a>. Thanks!</p>
</section>
</body>
</document>

1
pmd/xdocs/navigation.xml
View File

@ -20,6 +20,7 @@
<item name="Ant task usage" href="/ant-task.html" />
<item name="IDE plugin usage" href="/integrations.html" />
<item name="PMD in the news" href="/news.html" />
<item name="Best practices" href="/bestpractices.html" />
<item name="Finding copied and pasted code" href="/cpd.html" />
<item name="Similar projects" href="/similar-projects.html" />
<item name="Credits" href="/credits.html" />