API文档缺陷自动检测和修复方法

Novel approach to automatically detect and repair defective API documentation

为了完善应用程序编程接口(application programming interface,API)文档,提出了基于程序静态分析和自然语言处理的自动检测和修复API文档缺陷的方法。该方法能够自动检测和修复API文档缺陷。实验中缺陷检测结果的准确率和召回率分别达到74. 6%和81. 4%,能够较为准确地检测到Java API的文档缺陷。在进一步的实验中还对API文档的修复功能进行了评估,结果表明生成的文档正确且简洁,可以有效地修复API文档缺陷。

For improving API documentation,this paper proposed a novel approach to automatically detect and repair defective API documentation by adopting techniques of program static analysis and natural language processing. Across empirical studies,the proposed approach gave a precision of 74. 6% and a recall rate of 81. 4%,which demonstrated that the approach could accurately detect the defective documentation in Java API. For further experiments,this paper evaluated the function of repair recommendation for API documentation. The results indicate that the generated recommendations are correct and succinct,and can repair API documentation effectively.