Using stereotypes in the automatic generation of natural language summaries for C++ methods
Authors:
- 1 September 2015
- conference paper
- Published by Institute of Electrical and Electronics Engineers (IEEE)
- p. 561-565
Abstract
An approach to automatically generate natural language documentation summaries for C++ methods is presented. The approach uses prior work by the authors on stereotyping methods along with the source code analysis framework srcML. First, each method is automatically assigned a stereotype(s) based on static analysis and a set of heuristics. Then, the approach uses the stereotype information, static analysis, and predefined templates to generate a natural-language summary for each method. This summary is automatically added to the code base as a comment for each method. The predefined templates are designed to produce a generic summary for specific method stereotypes. Static analysis is used to extract internal details about the method (e.g., parameters, local variables, calls, etc.). This information is used to specialize the generated summaries.Keywords
This publication has 21 references indexed in Scilit:
- Selection and presentation practices for code example summarization2014
- Automatic documentation generation via source code summarization of method context2014
- CODES: mining source code descriptions from developers discussions2014
- Improving automated source code summarization via an eye-tracking study of programmers2014
- Evaluating source code summarization techniques: Replication and expansion2013
- Generating natural language summaries for crosscutting source code concerns2011
- Lightweight Transformation and Fact Extraction with the srcML Toolkit2011
- Generating Parameter Comments and Integrating with Method Summaries2011
- Towards automatically generating summary comments for Java methods2010
- Maintaining mental models2006