Automatic comment generation using the source code

Abstract

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

Bu çalışmada, kaynak kodlara metot seviyesinde yorum ekleme işinin otomatikleştirilmesi anlatılmaktadır. Kodların, Java programlama dilinin sözdizim kurallar ona 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. Ancak kaynak kodlu Java projeleri üzerinde yapılan çalışmayla farklı metot türleri için farklı şablonlar geliştirilmiştir. Yazılımcı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.