Framework Code Samples: How Are They Maintained and Used by Developers?
Gabriel Menezes, Bruno Cafeo, Andre Hora
Background: Modern software systems are commonly built on the top of frameworks. To accelerate the learning process of features provided by frameworks, code samples are made available to assist developers. However, we know little about how code samples are actually developed. Aims: In this paper, we aim to fill this gap by assessing the characteristics of framework code samples. We provide insights on how code samples are maintained and used by developers. Method: We analyze 233 code samples of Android and SpringBoot, and assess aspects related to their source code, evolution, popularity, and client usage. Results: We find that most code samples are small and simple, provide a working environment to the clients, and rely on automated build tools. They change frequently over time, for example, to adapt to new framework versions. We also detect that clients commonly fork the code samples, however, they rarely modify them. Conclusions: We provide a set of lessons learned and implications to creators and clients of code samples to improve maintenance and usage activities.
Introduction and Background
Modern software systems are commonly implemented with the support of frameworks, which provide feature reuse, improve productivity, and decrease costs. Frameworks support the development of mobile apps, web platforms, responsive interfaces, cross-platform systems, among other. In the Java ecosystem, for example, there are more than 270,000 packages available to be used by client systems in the Maven repository In the JavaScript ecosystem the numbers are even higher: the npm repository has over 400,000 packages and reports 6 billions downloads in a single month
To facilitate and accelerate the learning process of features provided by frameworks, code samples are commonly made available to assist development efforts. Code samples are often provided by world-wide software projects and organizations, such as Android, Spring, Google Maps, Twitter, Microsoft, to name a few. Framework code samples may introduce the usage of basic features, as well as more advanced ones. For instance, a basic sample provided by the SpringBoot framework help newcomer developers on building RESTful web services, In contrast, a more advanced code sample made available by the same framework help developers on securing web applications, Due to their practicality, client developers may copy and paste code samples into their own code base, and may put them into production. Thus, ideally, code samples should follow some good development practices, such as be simple, small, self-contained, easy to understand, secure, and efficient
Code Samples In A Nutshell
Framework code samples aim to facilitate and accelerate the learning process of features provided by frameworks. In this context, Oracle states that “code sample is provided for educational purposes or to assist your development or administration efforts”. Spring reports that “code samples are designed to get you productive as quickly as possible”.
Popular frameworks make code samples available to assist their client developers. The Android framework, for example, has more than one hundred samples on GitHub to help the creation of mobile apps. The SpringBoot framework also has dozens of samples to support the implementation of web apps. In addition to those well-known frameworks, code samples are often provided by organizations to facilitate the usage of their technologies, such as Google Maps APIs, Twitter APIs, Microsoft platforms, Apple platforms, among other.
In order to create good code samples, some guidelines are available. For example, the Code example guidelines provided by Mozilla states general practices related to the size, understandability, simplicity, self-containment, security, and efficiency. Guidelines also exist to set up the formatting of code samples, as the one provided by Google. In addition, numerous blogs on programming practices support the developers who are in charge of creating code samples.
Study Design
A. Selecting the Case Studies
In this study, we assess the code samples provided by two world wide frameworks: Android and SpringBoot.
The Android framework18 allows the creation of Android apps for several devices, such as smartphones, smartwatches, and TVs. Android code samples are publicly available on GitHub19 and help developers dealing with Android features, such as permissions, picture and video manipulation, background tasks, notifications, networks, multiple touch events, among many other. The SpringBoot framework20 mostly support the development of web applications. It also provides a set of code samples publicly available on GitHub21 to help developers creating web apps, such as dealing with RESTful web services, scheduling tasks, uploading files, valid
剩余内容已隐藏，支付完成后下载完整资料
毕业设计(论文)外文翻译
|
课题名称 |
基于SpringBoot layUI医院 |
|
管理系统的设计与实现 |
|
|
院 （系） |
计算机科学与技术学院 |
|
专 业 |
计算机科学与技术 |
|
姓 名 |
陈美进 |
|
学 号 |
1401170517 |
|
起讫日期 |
2020年12月～2021年2月 |
|
指导教师 |
刘小刚 |
2021年 2 月 23 日
Framework Code Samples: How Are They Maintained and Used by Developers?
Gabriel Menezes, Bruno Cafeo, Andre Hora
Background: Modern software systems are commonly built on the top of frameworks. To accelerate the learning process of features provided by frameworks, code samples are made available to assist developers. However, we know little about how code samples are actually developed. Aims: In this paper, we aim to fill this gap by assessing the characteristics of framework code samples. We provide insights on how code samples are maintained and used by developers. Method: We analyze 233 code samples of Android and SpringBoot, and assess aspects related to their source code, evolution, popularity, and client usage. Results: We find that most code samples are small and simple, provide a working environment to the clients, and rely on automated build tools. They change frequently over time, for example, to adapt to new framework versions. We also detect that clients commonly fork the code samples, however, they rarely modify them. Conclusions: We provide a set of lessons learned and implications to creators and clients of code samples to improve maintenance and usage activities.
Introduction and Background
Modern software systems are commonly implemented with the support of frameworks, which provide feature reuse, improve productivity, and decrease costs. Frameworks support the development of mobile apps, web platforms, responsive interfaces, cross-platform systems, among other. In the Java ecosystem, for example, there are more than 270,000 packages available to be used by client systems in the Maven repository In the JavaScript ecosystem the numbers are even higher: the npm repository has over 400,000 packages and reports 6 billions downloads in a single month
To facilitate and accelerate the learning process of features provided by frameworks, code samples are commonly made available to assist development efforts. Code samples are often provided by world-wide software projects and organizations, such as Android, Spring, Google Maps, Twitter, Microsoft, to name a few. Framework code samples may introduce the usage of basic features, as well as more advanced ones. For instance, a basic sample provided by the SpringBoot framework help newcomer developers on building RESTful web services, In contrast, a more advanced code sample made available by the same framework help developers on securing web applications, Due to their practicality, client developers may copy and paste code samples into their own code base, and may put them into production. Thus, ideally, code samples should follow some good development practices, such as be simple, small, self-contained, easy to understand, secure, and efficient
Code Samples In A Nutshell
Framework code samples aim to facilitate and accelerate the learning process of features provided by frameworks. In this context, Oracle states that “code sample is provided for educational purposes or to assist your development or administration efforts”. Spring reports that “code samples are designed to get you productive as quickly as possible”.
Popular frameworks make code samples available to assist their client developers. The Android framework, for example, has more than one hundred samples on GitHub to help the creation of mobile apps. The SpringBoot framework also has dozens of samples to support the implementation of web apps. In addition to those well-known frameworks, code samples are often provided by organizations to facilitate the usage of their technologies, such as Google Maps APIs, Twitter APIs, Microsoft platforms, Apple platforms, among other.
In order to create good code samples, some guidelines are available. For example, the Code example guidelines provided by Mozilla states general practices related to the size, understandability, simplicity, self-containment, security, and efficiency. Guidelines also exist to set up the formatting of code samples, as the one provided by Google. In addition, numerous blogs on programming practices support the developers who are in charge of creating code samples.
Study Design
A. Selecting the Case Studies
In this study, we assess the code samples provided by two world wide frameworks: Android and SpringBoot.
The Android framework18 allows the creation of Android apps for several devices, such as smartphones, smartwatches, and TVs. Android code samples are publicly available on GitHub19 and help developers dealing with Android features, such as permissions, picture and video manipulation, background tasks, notifications, networks, multiple touch events, among many other. The SpringBoot framework20 mostly support the development of web applications. It also provides a set of code samples publicly available on GitHub21 to help developers creating web apps, such as dealing with RESTful web services, scheduling tasks, uploading files, valid
剩余内容已隐藏，支付完成后下载完整资料
资料编号：[259793]，资料为PDF文档或Word文档，PDF文档可免费转换为Word
以上是毕业论文外文翻译，课题毕业论文、任务书、文献综述、开题报告、程序设计、图纸设计等资料可联系客服协助查找。
