Automatically generating documentation on application programming interfaces

摘要

Some embodiments of a system and a method to automatically generate documentation on application programming interfaces (APIs) have been presented. For instance, while a processor is building a software system from programming code including APIs, the processor may extract objects related to the APIs from comments embedded in the programming code and automatically generate documentation on the APIs using the objects extracted and templates associated with the objects extracted.

主权项

1. A method comprising:
building, by a processing device, a software system from programming code comprising application programming interfaces (APIs); extracting, by the processing device, objects related to the APIs; executing, by the processing device, macros embedded in comments using templates associated with the objects extracted, wherein the comments are embedded in the programming code; and generating, by the processing device, documentation on the APIs using the objects extracted and the executed macros while building the software system.