Skip to main content
J
Jandr123
Participating Frequently
April 12, 2011
Question

Is there documentation explaining the available rules?

  • April 12, 2011
  • 1 reply
  • 2592 views

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.

This topic has been closed for replies.

1 reply

A
Anonymous
April 12, 2011

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

J
Jandr123Author
Participating Frequently
April 13, 2011

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

A
Anonymous
April 13, 2011

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!

Terms & ConditionsAccessibility statement
Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices