You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the rule only enforces that the comment structure is present but not that each token has a value describing it (making the needed documentation still invalid), I've seen this especially when developers use extensions that automatically creates the empty boilerplate doc structure.
Code Sample demonstrating the issue:
/**
* @description
*/
public class Foo {
/**
* @description
* @param baz
* @return
*/
public String bar(String baz) {
return null;
}
}
Expected outcome:
The above code has the needed structure and tokens but no content to describe them, yet PMD still consider it valid according to the current rule.
Running PMD through:Apex PMD VSCode Extension
The text was updated successfully, but these errors were encountered:
Affects PMD Version:
6.8+
7.0.0
Rule:
ApexDoc
Description:
Currently the rule only enforces that the comment structure is present but not that each token has a value describing it (making the needed documentation still invalid), I've seen this especially when developers use extensions that automatically creates the empty boilerplate doc structure.
Code Sample demonstrating the issue:
Expected outcome:
The above code has the needed structure and tokens but no content to describe them, yet PMD still consider it valid according to the current rule.
Running PMD through: Apex PMD VSCode Extension
The text was updated successfully, but these errors were encountered: