English (United Kingdom)

https://curated-unify.zendy.io/wp-json/zendy-region/v1/featured_content/oa?rat=en

https://curated-unify.zendy.io/wp-json/zendy-region/v1/highlighted_journal/

Global: Zendy Plus annual

Presents the access of premium content as premium feature

Premium Content

Presents the keyphrase highlighting as premium feature

Keyphrase Highlighting

Presents the summarisation as premium feature

Summarisation

Insights

Presents the pdf analysis as premium feature

PDF Analysis

Presents the zaia usage as premium feature

ZAIA

Global: Zendy Plus monthly

Global: Zendy Tools annual

Global: Zendy Tools monthly

Global: Zendy Free Plan

Code comments can help in program comprehension and are considered asimportant artifacts to help developers in software maintenance. However, thecomments are mostly missing or are outdated, specially in complex softwareprojects. As a result, several automatic comment generation models aredeveloped as a solution. The recent models explore the integration of externalknowledge resources such as Unified Modeling Language class diagrams to improvethe generated comments. In this paper, we propose API2Com, a model thatleverages the Application Programming Interface Documentations (API Docs) as aknowledge resource for comment generation. The API Docs include the descriptionof the methods in more details and therefore, can provide better context in thegenerated comments. The API Docs are used along with the code snippets andAbstract Syntax Trees in our model. We apply the model on a large Java datasetof over 130,000 methods and evaluate it using both Transformer and RNN-basearchitectures. Interestingly, when API Docs are used, the performance increaseis negligible. We therefore run different experiments to reason about theresults. For methods that only contain one API, adding API Docs improves theresults by 4% BLEU score on average (BLEU score is an automatic evaluationmetric used in machine translation). However, as the number of APIs that areused in a method increases, the performance of the model in generating commentsdecreases due to long documentations used in the input. Our results confirmthat the API Docs can be useful in generating better comments, but, newtechniques are required to identify the most informative ones in a methodrather than using all documentations simultaneously.

API2Com: On the Improvement of Automatically Generated Code Comments Using API Documentations