eNeRGy164 / LivingDocumentation.Workshop

A workshop to start using Roslyn to generate documentation from your dotnet source code.

Living Documentation Workshop

Hello, welcome to the Living Documentation Workshop.

We are going to discover how we can use Roslyn to generate documentation from .NET source code.

Prerequisites

See INSTALLATION.md for details about all prerequisites.

Required Knowledge

• Be very experienced with C#
• Able to write LINQ queries
• Know how to clone git repos
• Have an understanding of DDD
• Have knowledge of Markdown
• Able to draw UML diagrams

Optional knowledge:

• Familair with AsciiDoc and PlantUML

Download this Workshop

Clone this workshop on your local system.

cd c:\git
git clone "https://github.com/eNeRGy164/LivingDocumentation.Workshop.git"

Structure

Part 1: Roslyn

• Get familiar with Syntax Trees

  Visually inspect the syntax tree of an application.

• Parse Source Code

  Parse a syntax tree and inspect the structure.

• Compile Source Code

  Compile a syntax tree and inspect the semantic model.

• Walk a Syntax Tree

  Use the visitor pattern to act on specific parts of your tree.

• Load a Project or Solution

  Use Buildalyzer to import a whole project or solution to work with.

Part 2: Generate documentation

• Living Documentation

  Quickly start acting on your code by generating an intermediate file with all relevant parts extracted from the syntax trees.

• Work with Types

  Get familiar with the types and start querying relations between classes, methods, invocations, etc.

• Generate documentation

  Build a document describing components based on the parts of you code.

• Generate a Class Diagram

  Build a class diagram from an aggregate.

• Generate a Sequence Diagram

  Build a sequence diagram from services interacting with each other.