• Refine Query
  • Source
  • Publication year
  • to
  • Language
  • 1
  • 1
  • Tagged with
  • 2
  • 2
  • 2
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • 1
  • About
  • The Global ETD Search service is a free service for researchers to find electronic theses and dissertations. This service is provided by the Networked Digital Library of Theses and Dissertations.
    Our metadata is collected from universities around the world. If you manage a university/consortium/country archive and want to be added, details can be found on the NDLTD website.
1

Reducing outdated and inconsistent code comments during software development : The comment validator program

Svensson, Adam January 2015 (has links)
During software development various forms of software documentation can be produced to make the software easier to understand and maintain after the software have been developed. One of these forms of software documentation is code comments, which is a form of software documentation that is produced to make source code easier to read and maintain. Although code comments make the code easier to read and maintain, code comments can become outdated and inconsistent with their corresponding code. Outdated and inconsistent code comments increase the probability for future bugs and when these comments are encountered, developers could lose the confidence for all other comments. In order to reduce the amount of outdated and inconsistent code comments, a program named the comment validator is presented in this study. The comment validator provides developers with the opportunity to manually validate code comments by segmenting code into three segments of code that needs to be manually validated: classes, methods and properties. The comment validator identifies when code segments have been modified after validation, therefore indicating that the code segments corresponding code comments could be outdated and inconsistent. The comment validator were evaluated through functional testing and through a field study in order to test that the comment validator could reduce the amount of outdated and inconsistent code comments. The evaluation showed that the comment validator did remove outdated and inconsistent code comments when it were used according to the description presented in this study, therefore providing a new way to reduce the amount of outdated and inconsistent code comments in software development projects.
2

Kodkommentarer som hjälper eller stjälper : En fallstudie om systemutvecklares inställningar till kodkommentarer och dess bakomliggande orsaker

Claesson, Hanna, Hansen, Johanna January 2022 (has links)
Software documentation, including code comments, is by many considered an important aspect in the process of software development. In the scientific literature, the perception that code comments increase the understanding of the code appears to be widely accepted. There are however studies indicating that this is not the case and that code comments often are inadequate and erroneous. In order to find out what the opinions on the subject of code comments are amongst software developers themselves, this study intends to investigate their attitudes towards code commenting and the reasons behind these attitudes. A qualitative case study containing eight semi-structured interviews with software developers from a large company in the IT-consulting business have been conducted. The data from the interviews have been analyzed in relation to the Reasoned Action Approach (RAA) in order to gain a deeper understanding of the underlying causes of the software developers’ attitudes. The study found that the majority of the software developers carried an attitude that was considered predominantly negative towards code comments, whereas a small minority displayed a more positive attitude. Some of the attitudes identified from the interview data were that code comments can convey information that is not apparent in the code, comments should only be added when there is a clear need, that the correctness and up-to-dateness of code comments cannot be relied upon and that comments make the code more difficult to read. / Systemdokumentation, och däribland kodkommentarer, är något som av många anses vara viktigt i systemutvecklingsprocessen. I litteraturen inom området verkar det råda en allmänt accepterad uppfattning om att kodkommentarer ökar förståelsen för koden. Det finns dock studier som visar på att så inte är fallet och att kodkommentarer ofta är bristfälliga och felaktiga. För att ta reda på vad systemutvecklare själva har för åsikt när det kommer till kodkommentarer ämnar denna studie undersöka systemutvecklares inställningar till kodkommentarer och de bakomliggande orsakerna till dessa. Genom en kvalitativ fallstudie har åtta semistrukturerade intervjuer utförts med systemutvecklare på ett stort konsultföretag inom IT. Det insamlade intervjumaterialet har sedan analyserats och relaterats till The Reasoned Action Approach (RAA) för att få en djupare förståelse för de bakomliggande orsakerna till systemutvecklarnas inställningar. Studien kom fram till att majoriteten av systemutvecklarna hade en övervägande negativ inställning till kodkommentarer, men ett fåtal visade på en något mer positiv inställning. Några av de inställningar som gick att identifiera från det empiriska materialet var bland annat att kommentarer kan förmedla sådant som inte framgår i koden, kommentarer ska endast skrivas när det finns ett tydligt behov, kommentarers riktighet och aktualitet går inte att lita på, samt att kommentarer försvårar kodens läsbarhet.

Page generated in 0.0748 seconds