Use your source code to document your application
summary
Tool walks C# syntax trees and the semantic model to extract real behavior: it finds command and event types, locates command handlers and all event subscribers, traces invocations of publish calls through nested statements, and flags commands or events with no handlers. Workspace loading uses MSBuild or Buildalyzer to compile symbol info; a 17s full analysis is typical but the tool caches JSON for fast iterations. Output renders as PlantUML, Markdown/AsciiDoc and as JSON output for further processing.
AI-written summary · about
chapters (22)
- 0:00Source code documentation
- 1:04Documentation challenges
- 3:25Why developers avoid documentation
- 6:05Existing docs solutions
- 9:26Living documentation
- 12:10Roslyn syntax trees
- 25:10Walking syntax tree
- 29:06Roslyn workspaces
- 31:22Source code structure
- 33:27Automated docs tools
- 36:17Docs from event flows
- 40:09Command handler analysis
- 43:10Event handler interactions
- 47:21Generated docs formatting
- 50:13API docs preview
- 52:08Automation in dev cycles
- 53:36Sequence diagrams from code
- 55:58Diagrams for architecture
- 57:31OpenAPI integration
- 58:18Future of auto docs
- 59:21Inspiration and tools
- 1:00:03Q&A
related talks
01h 02mUse your source code to document your application
01h 00mUse your source code to document your application
01h 16mAutomate yourself out of a job with Roslyn
01h 08mAnalyzing source code using Roslyn
01h 00mAutomate Yourself Out of a Job with Roslyn
59mC# Source Generators - Write code that writes code
53mTools and practices to help you deal with legacy code
33mSource Generators in Action