Gabriele Sara
Dear Diary: Helping novices creating better code documentation.
Rel. Luigi De Russis, Juan Pablo Saenz Moreno. Politecnico di Torino, Master of science program in Computer Engineering, 2023
|
Preview |
PDF (Tesi_di_laurea)
- Thesis
Licence: Creative Commons Attribution Non-commercial No Derivatives. Download (4MB) | Preview |
Abstract
While developing of a new project, novices often neglect the creation of useful documentation, which is usually composed of comments whose helpfulness is minimal for future reference and understanding. Moreover, such documentation lacks relative and contextual information, including errors encountered and the corresponding solutions found, lessons learned, consulted documents, choices and missteps made. By giving a seamless way to create artifacts with rich data, novices can generate valuable documentation for themselves and other developers. Thereby, in this thesis, I designed and developed Dear Diary, a Visual Studio Code extension that allows non-expert programmers to generate pieces of documentation directly in the IDE.
Other than capturing code snippets, files, or entire projects, the tool automatically collects useful information such as the file tree, the dependencies, and the command line scripts
Relators
Academic year
Publication type
Number of Pages
Course of studies
Classe di laurea
URI
![]() |
Modify record (reserved for operators) |
