Adam
/
Mango.Nop.Plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add XML doc conventions and update references 

Added a section on XML documentation standards to CONVENTIONS.md, clarified references to core and Mango.Nop framework convention docs, and improved formatting. Enabled EmitCompilerGeneratedFiles in Mango.Nop.Core.csproj.
This commit is contained in:
Loretta 2026-05-23 09:27:35 +02:00
parent 3cc775c264
commit 6c60d7b403
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Nop.Plugin.Misc.AIPlugin/docs/CONVENTIONS.md Normal file
View File

@ -0,0 +1,8 @@
# Conventions
> For core framework conventions see `AyCode.Core/docs/CONVENTIONS.md`.
> For Mango.Nop framework conventions see `Mango.Nop.Core/docs/CONVENTIONS.md`.
## XML Documentation
`<summary>` — 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 `<example>` only when usage is non-obvious; otherwise omit.