Detecting API documentation errors | |
Zhong, Hao (1) ; Su, Zhendong (2) | |
刊名 | ACM SIGPLAN Notices
![]() |
2013 | |
卷号 | 48期号:10页码:803-815 |
关键词 | Documentation Experimentation Reliability API documentation error Outdated documentation |
ISSN号 | 15232867 |
中文摘要 | When programmers encounter an unfamiliar API library, they often need to refer to its documentations, tutorials, or discussions on development forums to learn its proper usage. These API documents contain valuable information, but may also mislead programmers as they may contain errors (e.g., broken code names and obsolete code samples). Although most API documents are actively maintained and updated, studies show that many new and latent errors do exist. It is tedious and error-prone to find such errors manually as API documents can be enormous with thousands of pages. Existing tools are ineffective in locating documentation errors because traditional natural language (NL) tools do not understand code names and code samples, and traditional code analysis tools do not understand NL sentences. In this paper, we propose the first approach, DocRef, specifically designed and developed to detect API documentation errors. We formulate a class of inconsistencies to indicate potential documentation errors, and combine NL and code analysis techniques to detect and report such inconsistencies. We have implemented DocRef and evaluated its effectiveness on the latest documentations of five widely-used API libraries. DocRef has detected more than 1,000 new documentation errors, which we have reported to the authors. Many of the errors have already been confirmed and fixed, after we reported them. Copyright © 2013. Copyright © 2013 ACM. |
英文摘要 | When programmers encounter an unfamiliar API library, they often need to refer to its documentations, tutorials, or discussions on development forums to learn its proper usage. These API documents contain valuable information, but may also mislead programmers as they may contain errors (e.g., broken code names and obsolete code samples). Although most API documents are actively maintained and updated, studies show that many new and latent errors do exist. It is tedious and error-prone to find such errors manually as API documents can be enormous with thousands of pages. Existing tools are ineffective in locating documentation errors because traditional natural language (NL) tools do not understand code names and code samples, and traditional code analysis tools do not understand NL sentences. In this paper, we propose the first approach, DocRef, specifically designed and developed to detect API documentation errors. We formulate a class of inconsistencies to indicate potential documentation errors, and combine NL and code analysis techniques to detect and report such inconsistencies. We have implemented DocRef and evaluated its effectiveness on the latest documentations of five widely-used API libraries. DocRef has detected more than 1,000 new documentation errors, which we have reported to the authors. Many of the errors have already been confirmed and fixed, after we reported them. Copyright © 2013. Copyright © 2013 ACM. |
收录类别 | SCI ; EI |
语种 | 英语 |
WOS记录号 | WOS:000327697300045 |
公开日期 | 2014-12-16 |
内容类型 | 期刊论文 |
源URL | [http://ir.iscas.ac.cn/handle/311060/16909] ![]() |
专题 | 软件研究所_软件所图书馆_期刊论文 |
推荐引用方式 GB/T 7714 | Zhong, Hao ,Su, Zhendong . Detecting API documentation errors[J]. ACM SIGPLAN Notices,2013,48(10):803-815. |
APA | Zhong, Hao ,&Su, Zhendong .(2013).Detecting API documentation errors.ACM SIGPLAN Notices,48(10),803-815. |
MLA | Zhong, Hao ,et al."Detecting API documentation errors".ACM SIGPLAN Notices 48.10(2013):803-815. |
个性服务 |
查看访问统计 |
相关权益政策 |
暂无数据 |
收藏/分享 |
除非特别说明,本系统中所有内容都受版权保护,并保留所有权利。
修改评论