Fix XML documentation generation to appear in IDE tooltips + recommend markdown

Co-authored-by: omegaleo <5655201+omegaleo@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-02-11 23:07:32 +00:00
parent 22c5c4bfd3
commit f5b0e3209e
4 changed files with 61 additions and 8 deletions
+27 -2
View File
@@ -22,12 +22,37 @@ If you want to use the XmlDocGenerator standalone:
dotnet add package OmegaLeo.HelperLib.XmlDocGenerator
```
## Usage Best Practices
### ✨ Recommended: Use Markdown in Code Examples
For the best IDE experience, **use markdown code fences** in your `codeExample` parameter:
```csharp
[Documentation(
"MyMethod",
"Does something cool",
new[] { "param: Description" },
@"```csharp
// Markdown code fence provides syntax highlighting!
MyMethod(""example"");
```"
)]
public void MyMethod(string param) { }
```
**Benefits:**
- ✅ Proper syntax highlighting in Visual Studio, Rider, and VS Code
- ✅ Better formatting in IntelliSense tooltips
- ✅ Professional appearance
- ✅ Works with documentation generators
## How It Works
1. **MSBuild Integration**: The package includes MSBuild targets that are automatically imported
2. **Build-Time Generation**: Runs after CoreCompile to analyze your compiled assembly
2. **Build-Time Generation**: Runs after Build to augment your final XML documentation
3. **Attribute Reading**: Uses reflection to read DocumentationAttribute instances
4. **XML Generation**: Creates/augments XML documentation files
4. **XML Generation**: Creates/augments XML documentation files in your output directory
5. **IntelliSense Ready**: IDEs automatically pick up the generated XML
## Features