Automatic comment generation using the source code

Abstract

Bu çalışmada, kaynak kodlara metot seviyesinde yorum ekleme işinin otomatikleştirilmesianlatılmaktadır. Kodların, Java programlama dilinin sözdizim kurallarına uygun olması yeterli olup, çalışabilir durumda olması beklenmemektedir. Yorum üretmek için kaynak kod biçimsel açıdan incelenir. Bu aşamada ilgili metodun sadece imzasına ve geri döndürdüğü veri tipine ihtiyaç duyulur. Açık kaynak kodlu Java projeleri üzerinde yapılan çalışmayla farklı metot türleri için farklı şablonlar geliştirilmiştir. Yazılımcının geliştirdiği kodun incelenmesi sonucu derlenen bilgi ile bu şablonlardan en uygun olanı seçilir ve metinler oluşturulur.Bu metinler metodun amacını açıklar. Oluşturulan metinler yorum olarak kaynak koda eklenmektedir.

In this study, automatic comment generation for Java methods is described. Itis sufficient that the codes conform to the syntax rules of the Java programminglanguage, and it is not expected to be runnable. In order to generate comments,source code is examined syntactically. At this stage, only the method signatureand its return type is needed. By working on open source Java projects, differenttemplates have been developed for different method types. Using the compiledinformation which is the result of the examining source code that is currentlybeing developed, the most suitable template is chosen and texts are created.These texts explain the aim of the method. Created texts are added to sourcecode as a comment.