Why API documentation is insufficient for developers:an empirical study

来源 :中国科学:信息科学(英文版) | 被引量 : 0次 | 上传用户:peng6265066
下载到本地 , 更方便阅读
声明 : 本文档内容版权归属内容提供方 , 如果您对本文有版权争议 , 可与客服联系进行内容授权或下架
论文部分内容阅读
Dear editor,rnApplication programming interface(API)documentation plays an important role in software development and reuse[1]for both API maintainers and API users.Well-written documentation helps developers understand and reuse codes effectively[2]and focus their time on desired in-terfaces and functions instead of the entire system[3].Most high-quality open source projects maintain complete and in-formative official documentation.API documentation typi-cally conveys detailed specifications,such as class/interface hierarchies and method descriptions,which can be of great benefit to developers[4].However,despite its authoritative-ness and thoroughness,single-sourced official documenta-tion does not always meet the developers'requirements[5].As of January 2018,over 1 million posts about Android had been posted to StackOverflow and approximately 16%of these posts were related to its API(statistics found by searching for API and Android in StackOverflow).The lack of important information in API documentation makes de-velopers spend large amounts of time searching for informa-tion and seeking help.During this time,developers obtain large amounts of unconfirmed information,which can affect the quality of projects and the developers'understanding of the API.
其他文献
湖南省长沙市望城区,是伟大的共产主义战士雷锋同志的故乡.近两年,随着湖南省乡镇(街道)社工站建设工作的推进,望城区培育了一支本土化的专业社会工作队伍.上岗至今的800多个
期刊
近日,浙江省温州市鹿城区松台街道水心怀老站正式投入使用.水心怀老站是浙江安福利生慈善基金会为解决社区老人居家养老难题建设的平台,为社区老人提供养老设施、文体娱乐、
期刊
In 2008,Blockchain was introduced to the world as the underlying technology of the Bitcoin system.After more than a decade of development,various Blockchain sys
近年来,河北省以管宏观、管政策、管协调、管服务为切入点,以确保方向、激发活力、凝聚合力、做优生态为落脚点,推出一系列政策措施,将党管人才原则贯穿人才工作始终,全省人
期刊
2019年3月,甘肃省兰州市安宁区沙井驿街道根据《安宁区创建幸福社区工作方案》,采用政社合作的方式,引进了社工机构A为街道下辖的C社区提供专业社工服务。C社区是一个有着浓厚的“单位制”文化的企业社区,社区居民倾向于冷漠、孤立且封闭的状态,缺乏主动参与社区公共事务的动机和热情。本文以C社区为研究对象,在参与式行动研究的逻辑框架下,探索如何提升居民参与社区事务的意识和能力。
Mechanical ventilation is an effective medical means in the treatment of patients with critically ill,COVID-19 and other pulmonary diseases.During the mechanica
We have performed microwave diagnostics of the magnetic field strengths in solar flaring loops based on the theory of gyrosyn-chrotron emission.From Nobeyama Ra
佛冈县位于广东省中部,下辖6个镇、90个村(居),面积1302平方公里,户籍人口33万,其中未成年人82273人.截至2021年4月,佛冈县共有农村留守儿童139名,困境儿童1447名(含孤儿、事
期刊
近年来,贵州省正安县聚焦打造一支“不走的工作队”目标任务,想方设法吸引青年回村、乡贤回归,引凤还巢,按照把优秀农村致富带头人培养成党员、村级后备干部和村“两委”成员
期刊
近年来,陕西省宝鸡市民政局按照全市人才工作的总体部署,在省民政厅的精心指导下,以社会工作人才队伍能力提升为核心、以支持社会工作服务项目开展为基础、以专业社会工作者价值发挥为导向,枳极探索社会工作在助力脱贫攻坚与乡村振兴中的建设性作用。