From 92296c479bd7503465d218503e89487d7c97fcbe Mon Sep 17 00:00:00 2001 From: Loretta Date: Sat, 23 May 2026 09:27:29 +0200 Subject: [PATCH] Add XML doc standards; enable compiler-generated files Added "XML Documentation" section to CONVENTIONS.md, specifying usage of tags for developer-facing comments and restricting implementation details to external docs. Enabled EmitCompilerGeneratedFiles in FruitBank.Common.csproj for improved debugging and analysis. --- docs/CONVENTIONS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/CONVENTIONS.md b/docs/CONVENTIONS.md index 05c847d..baa3c60 100644 --- a/docs/CONVENTIONS.md +++ b/docs/CONVENTIONS.md @@ -18,6 +18,10 @@ Follow the doctrine in `../AyCode.Core/docs/CONVENTIONS.md#framework-first-place - **Services:** `Ac{Domain}ServiceBase` for abstract bases. Platform-specific implementations in consuming projects. - **ViewModels:** In `AyCode.Blazor.Models/ViewModels/` — suffixed with `ViewModel` or kept as plain model classes. +## XML Documentation + +`` — brief, developer-facing, readable in VS IntelliSense tooltip. NO implementation details, NO wire-format / byte-level / perf specifics — those live in `docs/TOPIC/*.md`. Add `` only when usage is non-obvious; otherwise omit. + ## Component Patterns - **DevExpress 25.1.3 exclusively** — never mix with other Blazor component libraries.