Missing custom object descriptions
Why is this an issue?
Custom objects without descriptions are harder to understand and maintain. This rule applies to every metadata type that uses the CustomObject element, including custom objects (__c), external objects (__x), big objects (__b), platform events (__e), and knowledge articles (__ka, __kav). Descriptions help developers and administrators:
Understand the object's purpose without examining its fields and relationships
Onboard new team members more quickly
Make informed decisions about schema changes
Examples
Example of incorrect metadata:
<CustomObject>
<label>Customer Order</label>
<!-- No description -->
</CustomObject>
Example of correct metadata:
<CustomObject>
<label>Customer Order</label>
<description>Represents a customer purchase order, linked to Account and containing Order Line Items. Used by the order management process.</description>
</CustomObject>
How can I fix violations?
Add a meaningful description to the object. The Setup UI path varies by object type — for example, custom objects live under Object Manager, while external objects, big objects, platform events, and knowledge articles each have their own dedicated Setup pages. In every case:
Navigate to the appropriate Setup page for the object type
Open the object and click Edit
Add a description explaining the object's purpose, relationships, and usage
Click Save
Or directly in metadata, regardless of object type:
<CustomObject>
<label>Customer Order</label>
<description>Represents a customer purchase order, linked to Account and containing Order Line Items. Used by the order management process.</description>
</CustomObject>
When should I disable this rule?
You may dismiss specific violations for temporary objects used only during development or migration.
Resources