Application Development Blog Posts
Learn and share on deeper, cross technology development topics such as integration and connectivity, automation, cloud extensibility, developing at scale, and security.
cancel
Showing results for 
Search instead for 
Did you mean: 
gaddamarunkumar
Explorer

This blog is to guide all Abapers on how to achieve clean code using ABAP Cleaner and not only to understand the advantages of clean ABAP and also how to use ABAP Cleaner.


ABAP Cleaner


The ABAP Cleaner tool is used to clean up ABAP code by applying various clean-up rules.


Here are some reasons why you might want to use the ABAP Cleaner tool:




  1. Automation: The ABAP Cleaner tool automates the process of cleaning up ABAP code, saving you time and effort.

  2. Uniformity: By using the ABAP Cleaner tool, you can ensure that your code follows a consistent style and structure. This improves code readability and makes it easier for other developers to understand and maintain the code.

  3. Error reduction: Following clean ABAP principles, which the ABAP Cleaner tool helps enforce, can reduce the number of errors and misunderstandings in your code. Clear and well-structured code is less prone to bugs and easier to debug.

  4. Modernization: The ABAP Cleaner tool encourages the use of modern language features and coding techniques. This is important if your organization plans to migrate to newer technologies like S/4HANA or the Cloud.

  5. Collective code ownership: Adopting clean ABAP practices fosters a culture of collective code ownership and feedback. It encourages collaboration and allows multiple developers to work on the same codebase more effectively.

  6. Maintainability: Clean ABAP code is easier to maintain and modify. It follows best code organization and readability practices, making it easier to add new features or make changes without introducing bugs.


What is ABAP Cleaner?


ABAP cleaner is a configurable tool that aims to automate whatever can be automated concerning ABAP code style.


What the ABAP Cleaner Tool Offers?


ABAP cleaner offers 59 cleanup rules with a total of 186 configuration options. Whereas, previously it offered 57 cleanup rules with a total of 162 configuration options.


Empty Lines




Spaces




Declarations




Syntax




Commands




Pretty Printer




Alignment




Requirements and Installation


To install and use the ABAP cleaner plug-in for ABAP Development Tools (ADT) on Windows or macOS,




  1. Install ABAP Development Tools as described in the Install ADT Tutorial (Step 1), using an Eclipse installation that is compatible with ADT.

  2. Start ADT, select the menu ‘Help / Install New Software…’, copy the link https://sap.github.io/abap-cleaner/updatesite to the ‘Work with’ field, and follow the installation steps, confirming to install ABAP cleaner. (Known issues)




After restarting ADT, open an ABAP code document in an editor, and use the menu ‘Source Code / Clean Up With Interactive ABAP Cleaner…’ (shortcuts Ctrl + 4 or Ctrl + Shift + 4),



If you select the first option “Clean Up with Automated ABAP Cleaner” it will automatically clean up the code based on the profile we have set up.


If you select the second option “Clean Up with Interactive ABAP Cleaner” here we can select the rules that we want to reflect in our code and here we have many options.



If we already created the profile, we can directly click on the “Save and Applybutton to apply the desired rules to be applied.


If we want to create a profile we need to click the configure button on the right corner.



On the top left in the profiles section we can Create, Copy, Delete, Import, and Export profiles.


On the bottom left in the rules section, we can check the checkbox that should clean up our code.


If the selection of rules is completed then click on the “save profiles and exit” button on the bottom right.


So, now we are set to give it a try.



In summary, the ABAP Cleaner tool is a valuable tool for automating the clean-up of ABAP code, ensuring uniformity, reducing errors, promoting modernization, fostering collective code ownership, and improving maintainability.


Have you used the ABAP Cleaner tool before? What was your experience like? Do you have any questions about Clean ABAP or the ABAP Cleaner tool?


Please feel free to share your thoughts in the comments section below.


If you enjoyed reading this blog post about Clean ABAP and would like to receive similar content in the future, please consider following my profile. By following my profile gaddamarunkumarreddy , you will receive updates on new blog posts and other content related to ABAP development best practices.


Follow the SAP ABAP environment Topic page: SAP ABAP


This page is a great resource for staying up-to-date on the latest news and developments in the SAP HANA environment. You can follow the page to receive updates, post and answer questions, and read other posts on the topic


If you have any queries related to SAP and ABAP Developments you can post here https://answers.sap.com/tags/73554900100700000996, you can also find many topics related to your query.



4 Comments