Is there documentation explaining the available rules?

[Jandr123]

When a rule complains about something,

I would like to understand why that something is bad, and how I can do better. I have been looking around but I have not been able to find a page containing such descriptions.

[Guest]

Hi,

if you use the eclipse plugin you should have some informative messages. You can see all the information along with some sample snippets in the ruleset creator:

http://opensource.adobe.com/svn/opensource/flexpmd/bin/flex-pmd-ruleset-creator.html

[Jandr123]

I have found the rule creator, but sometimes the explanation is just too

terse,

and I would like to know more about the reasons for the rule.

Another problem with the ruleset creator is that is does not offer a search

function.

If for instance I want the explanation for a message named

'CreationPolicySetToAll',

I have no choice but to visually scan for it in the 112 rules in the

ruleset.

Of course I could export it as a pmd.xml and search through that or

do you know of a better way?

Jan

[Guest]

very good points...

as for the explanations everything we have is in the ruleset. If you have questions about any rule don't hesitate to ask. We'll make our best to answer and integrate back the comments to the ruleset.

As for the search capabilities there's no better way that I'm aware of. It sounds like a reasonable enhancement, could you fill it in as an enhancement request?

Thanks!

[Jandr123]

Dear Xavi,

Thanks for the help. I created

FLEXPMD-241<https://mail.google.com/jira/browse/FLEXPMD-241>.

Jan