Clean SAPUI5: A Style Guide for Developers

SAPUI5 code needs to be easy to read and easy to update. Clean up your code with this guide from the experts! Learn how to leverage JavaScript features to write better SAPUI5 code. Then walk through detailed code examples and explanations for using modules, classes, functions, names, variables, literals, comments, code metrics, and more. Get the best practices you need for formatting, testing, implementation, and beyond!

• Learn to write readable and maintainable SAPUI5 code
• Improve the way you work with the JavaScript language, modules, functions, variables, and more
• Create descriptive program names, write strong comments, and format code correctly

Key Concepts

Understand the foundation of SAPUI5: JavaScript. Explore key JavaScript ES6 features such as arrow functions, spread syntax, and more. Then walk through different types of SAPUI5 projects, from library projects to freestyle applications.

Best Practices

Learn the rules for clean code. Dive into best practices for decoupling modules, structuring functions, declaring variables and literals, using control flow statements and loops, handling errors, performing automated tests, and more.

Practical Examples

Put theory into practice. Use detailed code examples for each concept to help you differentiate between clean and messy SAPUI5 code.

• JavaScript
• Modules and classes
• Functions
• Naming
• Variables and literals
• Control flow
• Formatting
• Error handling
• Comments
• Static code checks
• Testing
• Implementation

About the Author

Daniel Bertolozi is a software developer at SAP with more than 5 years of experience focused on SAP Fiori development. He has worked on several projects implementing SAPUI5 applications (in JavaScript and TypeScript) applying best practices for code quality, and he is actively engaged in disseminating agile software engineering practices around SAP. Daniel's approach to software development follows Robert C. Martin's phrase: "The only way to go fast, is to go well". If quality decreases, speed eventually will too, and that's what we want to avoid.

Arnaud Buchholz is a development expert at SAP, with a focus on designing, developing, and enhancing SAPUI5 applications. He has more than 20 years of experience in software development.

Klaus Haeuptleis a lead architect, servant leader, coach, and community lead. During his career at SAP, he has worked as a developer and architect on several products based on various technologies. Additionally, he facilitates communities across SAP with the intention of sharing knowledge and improving practices, tools, technologies, and culture. He has influenced many improvements on testability for ABAP, SAP HANA, SAPUI5, and other technologies.

Rodrigo Jordão is a development architect at SAP currently working on supply chain management and related solutions. He has spent his SAP career working on various SAP products, from industry-specific solutions like intellectual property management to foundational products like sales and distribution. Prior to joining SAP, he worked as a web developer with Perl and Java and as a consultant with Microsoft technologies.

Christian Lehmann is a development architect working in the SAP S/4HANA quality area. During his 16 years at SAP, he has worked on the design, implementation, and test automation of SAP-based products, including applications based on SAPUI5. He is a contributor to the SAP ASE community for ABAP and SAPUI5 topics, and enjoys experiencing new approaches for automated software testing.

Narendran NV is a senior developer, trainer, and security expert at SAP. Currently, he is part of a team that is focused on building advanced available-to-promise (ATP), which is an integral part of order fulfillment in SAP S/4HANA. Previously, he was part of the FXperience (Bangalore) team, which accelerates SAP Fiori adoption within SAP S/4HANA. Narendran believes that “knowledge is like a garden; if it is not cultivated, it cannot be harvested", so he makes time to coach teams on topics like agile software engineering, SAPUI5 and SAP Fiori elements, and recently, the ABAP RESTful application programming model. Prior to SAP, he worked with IBM as a consultant, contributing to custom development in the areas of travel & expense and finance.