基于版本历史的相关API方法推荐丰富API文档

Yuu Arimatsu, Yoshiya Ishida, Kunihiro Noda, Takashi Kobayashi
{"title":"基于版本历史的相关API方法推荐丰富API文档","authors":"Yuu Arimatsu, Yoshiya Ishida, Kunihiro Noda, Takashi Kobayashi","doi":"10.1109/DySDoc3.2018.00014","DOIUrl":null,"url":null,"abstract":"Application programming interfaces (APIs) enable developers to increase their productivity; however, developers have to expend much of their time to search API usages because API documentation often lacks some types of information such as co-use relationships between API methods or code examples. In this paper, we propose a technique to automatically generate enriched API documentation. Our technique identifies groups of relevant API methods by analyzing a software change history and inserts those into standard API documentation. Using our document, developers can easily find relevant API methods interactively according to their various development purposes.","PeriodicalId":375729,"journal":{"name":"2018 IEEE Third International Workshop on Dynamic Software Documentation (DySDoc3)","volume":"25 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2018-09-01","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"0","resultStr":"{\"title\":\"Enriching API Documentation by Relevant API Methods Recommendation Based on Version History\",\"authors\":\"Yuu Arimatsu, Yoshiya Ishida, Kunihiro Noda, Takashi Kobayashi\",\"doi\":\"10.1109/DySDoc3.2018.00014\",\"DOIUrl\":null,\"url\":null,\"abstract\":\"Application programming interfaces (APIs) enable developers to increase their productivity; however, developers have to expend much of their time to search API usages because API documentation often lacks some types of information such as co-use relationships between API methods or code examples. In this paper, we propose a technique to automatically generate enriched API documentation. Our technique identifies groups of relevant API methods by analyzing a software change history and inserts those into standard API documentation. Using our document, developers can easily find relevant API methods interactively according to their various development purposes.\",\"PeriodicalId\":375729,\"journal\":{\"name\":\"2018 IEEE Third International Workshop on Dynamic Software Documentation (DySDoc3)\",\"volume\":\"25 1\",\"pages\":\"0\"},\"PeriodicalIF\":0.0000,\"publicationDate\":\"2018-09-01\",\"publicationTypes\":\"Journal Article\",\"fieldsOfStudy\":null,\"isOpenAccess\":false,\"openAccessPdf\":\"\",\"citationCount\":\"0\",\"resultStr\":null,\"platform\":\"Semanticscholar\",\"paperid\":null,\"PeriodicalName\":\"2018 IEEE Third International Workshop on Dynamic Software Documentation (DySDoc3)\",\"FirstCategoryId\":\"1085\",\"ListUrlMain\":\"https://doi.org/10.1109/DySDoc3.2018.00014\",\"RegionNum\":0,\"RegionCategory\":null,\"ArticlePicture\":[],\"TitleCN\":null,\"AbstractTextCN\":null,\"PMCID\":null,\"EPubDate\":\"\",\"PubModel\":\"\",\"JCR\":\"\",\"JCRName\":\"\",\"Score\":null,\"Total\":0}","platform":"Semanticscholar","paperid":null,"PeriodicalName":"2018 IEEE Third International Workshop on Dynamic Software Documentation (DySDoc3)","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/DySDoc3.2018.00014","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 0

摘要

应用程序编程接口(api)使开发人员能够提高他们的生产力;然而,开发人员不得不花费大量时间来搜索API用法,因为API文档通常缺乏某些类型的信息,例如API方法或代码示例之间的共同使用关系。在本文中,我们提出了一种自动生成丰富的API文档的技术。我们的技术通过分析软件变更历史来识别相关的API方法组,并将它们插入到标准API文档中。使用我们的文档,开发人员可以轻松地根据他们的各种开发目的交互式地找到相关的API方法。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
查看原文
分享 分享
微信好友 朋友圈 QQ好友 复制链接
本刊更多论文
Enriching API Documentation by Relevant API Methods Recommendation Based on Version History
Application programming interfaces (APIs) enable developers to increase their productivity; however, developers have to expend much of their time to search API usages because API documentation often lacks some types of information such as co-use relationships between API methods or code examples. In this paper, we propose a technique to automatically generate enriched API documentation. Our technique identifies groups of relevant API methods by analyzing a software change history and inserts those into standard API documentation. Using our document, developers can easily find relevant API methods interactively according to their various development purposes.
求助全文
通过发布文献求助,成功后即可免费获取论文全文。 去求助
来源期刊
自引率
0.00%
发文量
0
期刊最新文献
Catalogen: Generating Catalogs of Code Examples Collected from OSS Automatically Redocumenting Source Code with Method and Class Stereotypes Generating an Interactive View of Dynamic Aspects of API Usage Examples DynaDoc: Automated On-demand Context-Specific Documentation Title Page i
×
引用
GB/T 7714-2015
复制
MLA
复制
APA
复制
导出至
BibTeX EndNote RefMan NoteFirst NoteExpress
×
×
提示
您的信息不完整,为了账户安全,请先补充。
现在去补充
×
提示
您因"违规操作"
具体请查看互助需知
我知道了
×
提示
现在去查看 取消
×
提示
确定
0
微信
客服QQ
Book学术公众号 扫码关注我们
反馈
×
意见反馈
请填写您的意见或建议
请填写您的手机或邮箱
已复制链接
已复制链接
快去分享给好友吧!
我知道了
×
扫码分享
扫码分享
Book学术官方微信
Book学术文献互助
Book学术文献互助群
群 号:481959085
Book学术
文献互助 智能选刊 最新文献 互助须知 联系我们:info@booksci.cn
Book学术提供免费学术资源搜索服务,方便国内外学者检索中英文文献。致力于提供最便捷和优质的服务体验。
Copyright © 2023 Book学术 All rights reserved.
ghs 京公网安备 11010802042870号 京ICP备2023020795号-1