Use your source code to document your application - Michaël Hompus - NDC Sydney 2024

This talk was recorded at NDC Sydney in Sydney, Australia. #ndcsydney #ndcconferences #developer #softwaredeveloper
Attend the next NDC conference near you:
ndcconferences.com
ndcsydney.com/
Subscribe to our KZbin channel and learn every day:
/ ‪@NDC‬
Follow our Social Media!
/ ndcconferences
/ ndc_conferences
/ ndc_conferences
#dotnet #continuousdelivery #code
For many development teams, writing and updating documentation can feel like a chore, especially when the codebase changes frequently. While developers often consider the source code as its own documentation, this perspective might not resonate with all stakeholders. Moreover, the source code might not adequately illustrate how different components interact.
What if we could transform our source code into comprehensive documentation that benefits both the team and stakeholders?
In this session, we will explore how to leverage Roslyn to generate documentation directly from your .NET source code. We'll delve into creating diagrams that depict the structure and relationships within an aggregate and sequence diagrams that illustrate the flow throughout the application. We'll render these using file formats such as PlantUML, Mermaid, Markdown, and AsciiDoc.
By the end of this session, you'll be equipped to let your source code articulate the operation of your application in a format that is accessible and meaningful to your team and stakeholders.
Key Takeaways:
* Learn how to use Roslyn to interpret your source code.
* Understand how to create and render diagrams that depict the structure and flow of your application.

[@AlexSchiessl]

Very nice, I can relate to it... I've done something similar 1990 (Querverweiser für C/C++ Programme auf der Basis eines YACC/Y+ generierten Parsers mit der Einbindung einer SDDS Schnittstelle ;-) ) in my diploma thesis, but only with C/C++ and text output only... No fancy graphics back then... But it is good that the spirit of source code driven documentation is still alive... And I will suggest this video to my team... Great work... Thanks for sharing...

[@Buy_YT_Views.415]

Like this comment or your dog will bite you.

[@kristiadhy]

I don't have a dog, so 🤷‍♂

[@mageshkumar01111987]

Same thing I tried 3 years back. Succeeded a bit but due to other commitments could not continue.