Skip to main content
Version: Next

apex md template

This template provides a standard Markdown format for documenting Apex (or other) class and interface indexes for discoverability and code suggestion enhancement.

Usage​

  • Copy this template and fill in the relevant class/interface/module details.
  • Use bold for class/interface names, italics for static methods/fields, and horizontal rules (---) to separate sections.
  • List method signatures and concise descriptions as bullet points.

ClassOrInterfaceName​

Path: relative/path/to/ClassOrInterface.cls

  • methodName(Type param1, Type param2): Short description of what the method does.
  • staticMethodName(Type param): Short description of what the static method does.
  • fieldName: Short description of the field.
  • STATIC_FIELD_NAME: Short description of the static field.

AnotherClassOrModule​

Path: relative/path/to/AnotherClassOrModule.cls

  • ...

Tip: For LWC/JS modules, use the same format but note the language/module type in the section header if needed.