ProjectHelm
Home / Documentation / Schema Documentation & XML Comments
Documentation

Schema Documentation & XML Comments

Every domain element supports rich descriptions that serve triple duty: C# XML doc comments, project file XML outputs, and contextual form help hints.

Updated September 2026 • 4 min read • .NET 10 & C#

ProjectHelm incorporates a unified Description property across 10 schema components: Domain Groups, Entities, Properties, Relations, Business Rules, Workflow Stages, Transitions, Enums, Enum Values, and Custom Permissions.

Triple-Duty Documentation Architecture

1. C# XML Documentation Comments

Generates /// <summary> comments on generated entity POCO classes, properties, navigation properties, DTOs, controllers, and CRUD actions.

2. Project XML Documentation Files

Emits <GenerateDocumentationFile>true</GenerateDocumentationFile> in .csproj files, enabling automated OpenAPI/Swagger documentation and Roslyn code analysis.

3. Contextual UI Help Hints

Renders helpful contextual hint text (<div class="form-text text-muted">) directly beneath form inputs on Create and Edit views for end users.