no-stack-dub-sack / apexdox-vs-code

A lightweight VS Code extension that makes documenting your Salesforce Apex files an easy, integrated experience.
Other
49 stars 7 forks source link

PMD Standard Rules and apexdox: @description #53

Closed Szandor72 closed 2 years ago

Szandor72 commented 2 years ago

Is there a way to comply with https://pmd.github.io/latest/pmd_rules_apex_documentation.html?

Standard PMD rules require @description for apex docs, like this:

/**
 * @description Hello World
 */
public class HelloWorld {
    /**
     * @description Bar
     * @return Bar
     */
    public Object bar() { return null; }
}

So far, I am adding @description manually.

dschach commented 2 years ago

This is covered in the README: https://github.com/no-stack-dub-sack/apexdox-vs-code#comment-block-settings

Szandor72 commented 2 years ago

I must have been extraordinarily blind before Dreamforce. Thank you, David.