RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.pmd-code.org/latest/pmd_rules_apex_documentation.html below:

Documentation | PMD Source Code Analyzer

Rules that are related to code documentation.

Table of Contents ApexDoc

Since: PMD 6.8.0

Priority: Medium (3)

This rule validates that:

ApexDoc comments are present for classes, methods, and properties that are public or global, excluding overrides and test classes (as well as the contents of test classes).
ApexDoc comments are present for classes, methods, and properties that are protected or private, depending on the properties reportPrivate and reportProtected.
ApexDoc comments should contain @description depending on the property reportMissingDescription.
ApexDoc comments on non-void, non-constructor methods should contain @return.
ApexDoc comments on void or constructor methods should not contain @return.
ApexDoc comments on methods with parameters should contain @param for each parameter, in the same order as the method signature.
ApexDoc comments are present on properties is only validated, if the property reportProperty is enabled. By setting reportProperty to false, you can ignore missing comments on properties.

Method overrides and tests are both exempted from having ApexDoc.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.apex.rule.documentation.ApexDocRule

Example(s):

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

This rule has the following properties:

Name Default Value Description reportPrivate false Report private classes, methods and properties reportProtected false Report protected classes, methods and properties reportMissingDescription true Report missing @description reportProperty true Report properties without comments

Use this rule with the default properties by just referencing it:

<rule ref="category/apex/documentation.xml/ApexDoc" />

Use this rule and customize it:

<rule ref="category/apex/documentation.xml/ApexDoc">
    <properties>
        <property name="reportPrivate" value="false" />
        <property name="reportProtected" value="false" />
        <property name="reportMissingDescription" value="true" />
        <property name="reportProperty" value="true" />
    </properties>
</rule>

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4