All public APIs must have comprehensive and clear documentation that helps developers understand functionality without examining implementation details. Follow these guidelines:

  1. Methods and classes: Document the purpose, behavior, parameters, and return values. Class-level documentation should explain usage patterns and limitations. ```java /**
  2. Empty or non-obvious implementations: Always include comments explaining why a method is empty or has unexpected behavior.
    @Override
    public void setValue(Number value) {
        // No action needed - this method intentionally left empty as value is managed by parent condition
    }
    
  3. Deprecation: Follow this format for all deprecated elements:
  4. Method references: Ensure @see and {@link} references are accurate and helpful. For overloaded methods, clearly specify which signature is being referenced and explain default behavior. ```java /**
  5. Special elements: Document enum values appropriately with Javadoc rather than inline comments.
    public enum WeightsFormat {
        /**
         * Kernel height, kernel width, input channels, output channels [kH, kW, iC, oC]
         */
        YXIO,
           
        /**
         * Output channels, input channels, kernel height, kernel width [oC, iC, kH, kW]
         */
        OIYX
    }