Extensible Visualization of C# Codebases

Bc. Adam Štěpánek

Master's thesis

Abstract:

Velké softwarové projekty je často obtížné pochopit. Čtení milionů řádků zdrojového kódu je příliš časově náročné. Přesto je však potřeba počítačovým programům rozumět, například při zácviku nových členů týmu, psaní dokumentace, nebo i jen přidávání nové funkcionality. Jeden ze způsobů, jak zlepšit jejich chápání, představuje softwarová vizualizace. Tato práce popisuje Helveg, vývojářský nástroj generující interaktivní diagramy softwarových projektů implementovaných v jazyce C#. Návrh tohoto nástroje vychází z analýzy podobných utilit a požadavků uživatelů. Je implementován jako konzolový program, jehož výstupem je webová aplikace obsažená v jediném souboru. Tento formát mu umožňuje produkovat snímky softwarové architektury, které nemají žádné další závislosti a lze je snadno sdílet. Výstup nástroje byl analyzován několika případovými studiemi za přítomnosti vývojařů vizualizovaných projektů. Výsledky ukazují, že Helveg může zlepšit chápání C# projektů různých velikostí a typů. Ač tento nástroj má své chyby, ty představují příležitosti k jeho dalšímu vývoji.

Abstract:

Large software projects are often not easy to comprehend. Reading their thousands or even millions of lines of code is too time-consuming. Yet, they must be understood, for example, while onboarding new team members, writing documentation, or simply adding new features. One way to improve program comprehension is through software visualization. This thesis presents Helveg, a developer tool generating interactive diagrams of C# codebases. Helveg's design is based on research of existing tools as well as a user requirement survey. It is implemented as a console program outputting single-file web applications. This format allows it to produce easily shareable, self-contained snapshots of a codebase's architecture. Furthermore, the visualization is analyzed through case studies on existing codebases and evaluated with the developers of the analyzed projects. Results show that Helveg can help programmers understand the architecture of C# projects of different sizes and types. Although the tool is not without issues, its shortcomings present opportunities for future development.

Keywords

software visualization, code analysis, C#, Roslyn, .NET Tool, software architecture diagram

Language used: English

Date on which the thesis was submitted / produced: 16. 5. 2023

Thesis defence

• Date of defence: 22. 6. 2023
• Supervisor: RNDr. David Kuťák
• Reader: RNDr. Filip Opálený

Masaryk University

Faculty of Informatics

Master programme / field:
Visual informatics / Computer Games Development