Taxonomy of inline code comment smells
Uygunsuz satır içi kod yorumlarının sınıflandırılması
- Tez No: 745303
- Danışmanlar: DR. ÖĞR. ÜYESİ ERAY TÜZÜN
- Tez Türü: Yüksek Lisans
- Konular: Bilgisayar Mühendisliği Bilimleri-Bilgisayar ve Kontrol, Computer Engineering and Computer Science and Control
- Anahtar Kelimeler: Sınıflandırma, Taksonomi, Veri setleri, Yorumlama, Classification, Taxonomy, Data sets, Interpretation
- Yıl: 2022
- Dil: İngilizce
- Üniversite: İhsan Doğramacı Bilkent Üniversitesi
- Enstitü: Mühendislik ve Fen Bilimleri Enstitüsü
- Ana Bilim Dalı: Bilgisayar Mühendisliği Ana Bilim Dalı
- Bilim Dalı: Belirtilmemiş.
- Sayfa Sayısı: Belirtilmemiş.
Özet
Kod yorumları, kaynak kodun anlaşılmasında ve yazılımın sürdürülebilirliğinde önemli bir rol oynar. Yazılım mühendisliğinde koda yorum eklemek genellikle iyi bir uygulama olarak kabul edilir. Fakat, düşük kaliteli yorumlar, yazılım kalitesi üzerinde negatif bir etkiye sahip olabilir veya kodun anlaşılması için etkisiz olabilir. Bu çalışmada, akademik ve gri literatür taraması yapılarak 11 türden oluşan satır içi kod yorum uygunsuzlukları sınıflandırıldı. Daha sonra, yarısının Java ve diğer yarısının Python projeleri olduğu sekiz açık kaynaklı projeden 2447 satır içi yorumu manuel olarak etiketlendi. Uygunsuzlukların hem Java hem de Python projelerinde değişen derecelerde var olduğu gözlenmiştir. Ayrıca, bu uygunsuzlukların kod anlama ve yazılım sürdürülebilirliği üzerindeki etkilerini öğrenmek için 41 yazılım geliştirici ile bir anket gerçekleştirildi. Anket katılımcıları genel olarak sınıflandırma konusunda hemfikir olduklarını belirtmiştir, ancak bazı senaryolarda bazı yorum uygunsuzluklarının kod anlama üzerinde olumlu etkisi olabileceğini bildirmişlerdir. Bunlara ek olarak, etiketli veri setini kullanarak yorum uygunsuzluklarını otomatik kategorize etmek için çeşitli makine öğrenmesi tabanlı modeller geliştirilmiş ve en iyi model 0,53'lik bir F1 puanı elde etmiştir. Etiketlenmiş veri kümemizi herkese açık şekilde paylaşıyor ve bu çalışmanın yazılım mühendisliği uygulayıcılarına, araştırmacılarına ve eğitimcilerine olan çıkarımlarına değiniyoruz.
Özet (Çeviri)
Code comments play a vital role in source code comprehension and software maintainability. It is common for developers to write comments to explain a code snippet, and commenting code is generally considered as a good practice in software engineering. However, low-quality comments can have a detrimental effect on software quality or be ineffective for code understanding. In this study, we conducted a multivocal literature review and created a taxonomy of inline code comments smells consisting of 11 types. Afterward, we manually labeled 2447 inline comments from eight open-source projects where half of them were Java, and another half were Python projects. We found out that the smells exist in both Java and Python projects with varying degrees. Moreover, we conducted an online survey with 41 software practitioners to learn their opinions on these smells and their effect on code comprehension and software maintainability. The survey respondents generally agreed with the taxonomy; however, they reported that some smell types might have a positive effect on code comprehension in certain scenarios. Additionally, using our labeled dataset, we developed various machine learning-based models to categorize the smell types automatically. Our best model achieved an F1 score of 0.53. We share our manually labeled dataset online and provide implications of this study for software engineering practitioners, researchers, and educators.
Benzer Tezler
- Denizcilik işletmelerine yönelik entelektüel sermaye değerlemesi üzerine bir model önerisi
A model proposal on valuation for intellectual capital of maritime businesses
GİZEM ÇEVİK
Doktora
Türkçe
2023
Denizcilikİstanbul Teknik ÜniversitesiDeniz Ulaştırma İşletme Mühendisliği Ana Bilim Dalı
PROF. DR. ÖZCAN ARSLAN
- Türkiye karayosunu florasına ait bazı Grimmiaceae arn. türlerinin spor morfolojilerinin incelenmesi
Spore morphology of some Grimmiaceae arn. species belongs to moss flora of Turkey
FATİH ÖZÇELİK
Yüksek Lisans
Türkçe
2014
BiyolojiEskişehir Osmangazi ÜniversitesiBiyoloji Ana Bilim Dalı
DOÇ. DR. FİLİZ SAVAROĞLU
- Türkiye'nin bazı gladiolus (Iridaceae) türleri üzerinde biyosistematik araştırmalar
Biyosystematical studies on some gladiolus (Iridaceae) species of Turkey
ERDAL ÜZEN
- An analysis of 5ᵀᴴ-grade mathematics tasks in Turkish and Singaporean textbooks according to Revised Bloom's Taxonomy and de Lange's context framework
Türkiye ve Singapur 5. sınıf matematik ders kitaplarındaki matematiksel görevlerin Bloom'un revize edilmiş taksonomisi ve de Lange'ın bağlam çerçevesine göre analizi
ÖZGE ATİLA
Yüksek Lisans
İngilizce
2025
Eğitim ve ÖğretimOrta Doğu Teknik ÜniversitesiMatematik ve Fen Bilimleri Eğitimi Ana Bilim Dalı
DR. ÖĞR. ÜYESİ IŞIL İŞLER BAYKAL
- İlkokul 3 ve 4. sınıf matematik ders kitaplarındaki etkinliklerin yenilenmiş Bloom taksonomisine göre incelenmesi
Examination of activities in the 3rd and 4th grade mathematics textbooks in primary school according to the revised Bloom taxonomy
BÜŞRA USLUOĞLU
Yüksek Lisans
Türkçe
2020
Eğitim ve ÖğretimKırıkkale Üniversitesiİlköğretim Ana Bilim Dalı
DOÇ. DR. VELİ TOPTAŞ