Standardize ABAP code samples across documentation

claude · claude · commit e55010d9d854 · 2026-02-11T16:50:13.000Z
- CLASS DEFINITION: standardize to `DEFINITION PUBLIC.` everywhere, removing redundant `FINAL CREATE PUBLIC` and `CREATE PUBLIC` - View builder variables: use short names (`view`, `page`, `tab`, `popup`, `columns`, `cells`) instead of `lo_view`, `lo_popup`, `lo_col`, `lo_cell`, `lo_columns`, `lo_cells` - Remove empty PROTECTED/PRIVATE SECTION from formatter.md - Fix inconsistent indentation in formatter.md second simple_form - Keep Hungarian notation (lo_, lv_, lt_) for actual object/value variables (lo_log, lo_app, lv_url etc.) 18 files updated across development, configuration, advanced, and technical sections. https://claude.ai/code/session_0165sq6V21ktTSAhKUW4r74K
diff --git a/docs/advanced/extensibility/user_exits.md b/docs/advanced/extensibility/user_exits.md
@@ -5,7 +5,7 @@ abap2UI5 contains predefined user exits which can be used to modify the standard
 The following example changes the title, theme and the time drafts are saved in the backend:
 
 ```abap
-CLASS zcl_a2ui5_user_exit DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS zcl_a2ui5_user_exit DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES  z2ui5_if_exit.
diff --git a/docs/configuration/authorization.md b/docs/configuration/authorization.md
@@ -11,16 +11,11 @@ One of the easiest ways to manage access to different apps is by implementing ch
 ##### Example: Restricting Access Based on URL Parameters
 In this example, we use the ICF handler class to control which apps can be accessed based on the APP_START parameter in the HTTP request. If an unauthorized app is requested, access is denied.
 ```abap
-CLASS z2ui5_cl_launchpad_handler DEFINITION
-  PUBLIC
-  FINAL
-  CREATE PUBLIC .
+CLASS z2ui5_cl_launchpad_handler DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES if_http_extension.
 
-  PROTECTED SECTION.
-  PRIVATE SECTION.
 ENDCLASS.
 
 CLASS z2ui5_cl_launchpad_handler IMPLEMENTATION.
diff --git a/docs/configuration/launchpad.md b/docs/configuration/launchpad.md
@@ -74,10 +74,7 @@ ENDINTERFACE.
 ```
 (2/3) Which can be used on app level to return KPIs:
 ```abap
-CLASS z2ui5_cl_lp_kpi_hello_world DEFINITION
-  PUBLIC
-  FINAL
-  CREATE PUBLIC .
+CLASS z2ui5_cl_lp_kpi_hello_world DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_lp_kpi.
diff --git a/docs/configuration/setup.md b/docs/configuration/setup.md
@@ -7,7 +7,7 @@ outline: [2, 4]
 You can run abap2UI5 with various custom configurations. The default setup is used automatically. For custom configurations, just implement the interface `z2ui5_if_exit`:
 
 ```abap
-CLASS zcl_a2ui5_user_exit DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS zcl_a2ui5_user_exit DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES  z2ui5_if_exit.
diff --git a/docs/development/events.md b/docs/development/events.md
@@ -94,7 +94,7 @@ You can access any object attribute, but make sure you access only public and re
 #### Model Properties
 Retrieve model properties associated with the event:
 ```abap
-CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -103,8 +103,7 @@ CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC CREATE PUBLIC.
 ENDCLASS.
 
 CLASS z2ui5_cl_app_hello_world IMPLEMENTATION.
-
-METHOD z2ui5_if_app~main.
+  METHOD z2ui5_if_app~main.
 
     client->view_display( z2ui5_cl_xml_view=>factory(
          )->input( client->_bind_edit( name )
diff --git a/docs/development/model/device.md b/docs/development/model/device.md
@@ -16,7 +16,7 @@ Explore all available parameters in the [UI5 Documentation.](https://sapui5.hana
 ### Backend
 You can also retrieve detailed device information on the backend using a custom info frontend control. This allows you to access UI5 version, device type, OS, browser details, and screen dimensions. Below is an example implementation, which demonstrates how to collect and use this information:
 ```abap
-CLASS z2ui5_cl_sample_device DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_device DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -41,8 +41,8 @@ CLASS z2ui5_cl_sample_device IMPLEMENTATION.
 
   METHOD z2ui5_if_app~main.
 
-    DATA(lo_view) = z2ui5_cl_xml_view=>factory(
-        )->page( )->_z2ui5( 
+    DATA(view) = z2ui5_cl_xml_view=>factory(
+        )->page( )->_z2ui5(
             )->info_frontend( 
                 finished          = client->_event( `POST` )
                 device_browser    = client->_bind_edit( device_browser )
@@ -58,7 +58,7 @@ CLASS z2ui5_cl_sample_device IMPLEMENTATION.
                 device_height     = client->_bind_edit( device_height  )
                 device_width      = client->_bind_edit( device_width   ) ).
 
-    client->view_display( lo_view->stringify( ) ).
+    client->view_display( view->stringify( ) ).
 
     IF client->get( )-event = `POST`.
       "process device info here...
diff --git a/docs/development/model/tables.md b/docs/development/model/tables.md
@@ -74,7 +74,7 @@ Making a table editable is a simple change. You just need to switch the binding
 ### Tree
 To work with trees, you need to use nested structures. Here is an example:
 ```abap
-CLASS z2ui5_cl_sample_tree DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_tree DEFINITION PUBLIC.
  
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -169,15 +169,15 @@ CLASS z2ui5_cl_sample_nested_structures IMPLEMENTATION.
 
     DATA(tab) = z2ui5_cl_xml_view=>factory( )->table( client->_bind( mt_itab ) ).
 
-    DATA(lo_columns) = tab->columns( ).
-    lo_columns->column( )->text( text = `Product` ).
-    lo_columns->column( )->text( text = `Created at` ).
-    lo_columns->column( )->text( text = `By` ).
+    DATA(columns) = tab->columns( ).
+    columns->column( )->text( text = `Product` ).
+    columns->column( )->text( text = `Created at` ).
+    columns->column( )->text( text = `By` ).
 
-    DATA(lo_cells) = tab->items( )->column_list_item( ).
-    lo_cells->text( `{PRODUCT}` ).
-    lo_cells->text( `{S_DETAILS/CREATE_DATE}` ).
-    lo_cells->text( `{S_DETAILS/CREATE_BY}` ).
+    DATA(cells) = tab->items( )->column_list_item( ).
+    cells->text( `{PRODUCT}` ).
+    cells->text( `{S_DETAILS/CREATE_DATE}` ).
+    cells->text( `{S_DETAILS/CREATE_BY}` ).
 
     client->view_display( tab->stringify( ) ).
 
diff --git a/docs/development/navigation/app_state.md b/docs/development/navigation/app_state.md
@@ -9,7 +9,7 @@ Each state is saved as a draft with a unique ID, you can display this ID in the
 ### Sample Code
 Below is an implementation of the app state functionality:
 ```abap
-CLASS z2ui5_cl_sample_app_state DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS z2ui5_cl_sample_app_state DEFINITION PUBLIC.
  
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/navigation/share.md b/docs/development/navigation/share.md
@@ -5,7 +5,7 @@ The app state feature opens up several useful scenarios, such as sharing and boo
 ### Share
 You can easily integrate a share button, which copies the actual state into the clipboard for sharing with your colleagues. Check out the following snippet:
  ```abap
-CLASS z2ui5_cl_sample_share DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS z2ui5_cl_sample_share DEFINITION PUBLIC.
  
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/popups.md b/docs/development/popups.md
@@ -13,10 +13,10 @@ To display a popup, use the method `client->popup_display` instead of `client->v
 ```abap
   METHOD z2ui5_if_app~main.
 
-    DATA(lo_popup) = z2ui5_cl_xml_view=>factory_popup(
+    DATA(popup) = z2ui5_cl_xml_view=>factory_popup(
         )->dialog( `Popup - Info`
           )->text( `this is an information shown in a popup` ).
-    client->popup_display( lo_popup->stringify( ) ).
+    client->popup_display( popup->stringify( ) ).
 
   ENDMETHOD.
 ```
@@ -27,25 +27,25 @@ A common flow for using popups typically involves displaying a normal view, then
   METHOD z2ui5_if_app~main.
 
     IF client->check_on_init( ).
-        DATA(lo_view) = z2ui5_cl_xml_view=>factory(
+        DATA(view) = z2ui5_cl_xml_view=>factory(
             )->page( `abap2UI5 - Popups`
                 )->button(
                     text  = `popup rendering, no background rendering`
                     press = client->_event( `POPUP_OPEN` ) ).
-        client->view_display( lo_view->stringify( ) ).
+        client->view_display( view->stringify( ) ).
 
     ENDIF.
 
     CASE client->get( )-event.
 
       WHEN `POPUP_OPEN`.
-        DATA(lo_popup) = z2ui5_cl_xml_view=>factory_popup(
+        DATA(popup) = z2ui5_cl_xml_view=>factory_popup(
             )->dialog( `Popup`
                 )->text( `this is a text in a popup`
                 )->button(
                     text  = `close`
                     press = client->_event( `POPUP_CLOSE` ) ).
-        client->popup_display( lo_popup->stringify( ) ).
+        client->popup_display( popup->stringify( ) ).
 
       WHEN `POPUP_CLOSE`.
         client->popup_destroy( ).
@@ -65,11 +65,11 @@ Check out the popup to confirm, for example:
     CASE abap_true.
 
       WHEN client->check_on_init( ).
-        DATA(lo_popup) = z2ui5_cl_pop_to_confirm=>factory(
+        DATA(popup) = z2ui5_cl_pop_to_confirm=>factory(
                           i_question_text = `Can you confirm this?`
                           i_event_confirm = `CONFIRM`
                           i_event_cancel  = `CANCEL` ).
-        client->nav_app_call( lo_popup ).
+        client->nav_app_call( popup ).
 
       WHEN client->check_on_event( `CONFIRM` ).
         client->message_box_display( `the result is confirmed` ).
diff --git a/docs/development/specific/barcodes.md b/docs/development/specific/barcodes.md
@@ -18,7 +18,7 @@ Since UI5 version 1.102, the `sap.ndc.BarcodeScannerButton` control is part of t
 ```abap
   METHOD z2ui5_if_app~main.
 
-    DATA(lo_view) = z2ui5_cl_xml_view=>factory(
+    DATA(view) = z2ui5_cl_xml_view=>factory(
         )->page(
             )->barcode_scanner_button(
                 dialogtitle = `Barcode Scanner`
@@ -28,7 +28,7 @@ Since UI5 version 1.102, the `sap.ndc.BarcodeScannerButton` control is part of t
                         ( `${$parameters>/text}`   )
                         ( `${$parameters>/format}` ) ) ) ).
 
-    client->view_display( lo_view->stringify( ) ).
+    client->view_display( view->stringify( ) ).
 
     IF client->get( )-event = `SCAN_SUCCESS`.
 
@@ -52,7 +52,7 @@ Most scanner devices have an integrated scanning function. In such cases, you ca
 Here’s an example that demonstrates how to handle input focus and manage transitions between fields after scanning and pressing ENTER:
 
 ```abap
-CLASS z2ui5_cl_sample_focus DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS z2ui5_cl_sample_focus DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -105,7 +105,7 @@ ENDCLASS.
 Providing audio feedback can be helpful in specific contexts. Below is an example that plays a sound if a user fails to scan a value. The sound file is a .wav file stored in the SAP MIME repository at `/SAP/PUBLIC/BC/ABAP/mime_demo/bam.wav`:
 
 ```abap
-CLASS z2ui5_cl_sample_sound DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_sound DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/specific/camera.md b/docs/development/specific/camera.md
@@ -7,7 +7,7 @@ abap2UI5 provides a custom control for capturing photos directly from the device
 
 Here's a basic example based on sample `z2ui5_cl_demo_app_306`:
 ```abap
-CLASS z2ui5_cl_demo_app_306 DEFINITION PUBLIC FINAL CREATE PUBLIC.
+CLASS z2ui5_cl_demo_app_306 DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/specific/cds.md b/docs/development/specific/cds.md
@@ -8,7 +8,7 @@ All examples in this documentation work without CDS or EML. However, if you're o
 ### ABAP CDS
 ABAP Core Data Services (CDS) enable you to define powerful views and consume data directly from the database. The following example demonstrates how to fetch sales orders using the I_SalesOrder view from the Virtual Data Model (VDM) and display them in a UI5 table:
 ```abap
-CLASS z2ui5_cl_sample_cds DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_cds DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -48,7 +48,7 @@ The Entity Manipulation Language simplifies working with RAP business objects by
 #### Read
 Here’s how to use `READ ENTITIES` to fetch sales orders and display them in a UI5 table:
 ```abap
-CLASS z2ui5_cl_sample_eml_read DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_eml_read DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/specific/formatter.md b/docs/development/specific/formatter.md
@@ -8,19 +8,13 @@ CLASS z2ui5_cl_demo_app_067 DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
-
     DATA amount            TYPE p LENGTH 14 DECIMALS 3.
     DATA currency          TYPE string.
-    DATA numeric           TYPE n length 12.
-
+    DATA numeric           TYPE n LENGTH 12.
     DATA check_initialized TYPE abap_bool.
 
-  PROTECTED SECTION.
-
-  PRIVATE SECTION.
 ENDCLASS.
 
-
 CLASS z2ui5_cl_demo_app_067 IMPLEMENTATION.
 
   METHOD z2ui5_if_app~main.
@@ -104,17 +98,15 @@ CLASS z2ui5_cl_demo_app_067 IMPLEMENTATION.
 
     page->simple_form( title    = `No Zeros`
                        editable = abap_true
-)->content( `form`
-)->title( `Input`
-)->label( `Documentation`
-)->link( text = `https://sapui5.hana.ondemand.com/sdk/#/api/sap.ui.model.odata.type.String%23methods/formatValue`
-         href = `https://sapui5.hana.ondemand.com/sdk/#/api/sap.ui.model.odata.type.String%23methods/formatValue`
-)->label( `Numeric`
-)->input( value = client->_bind_edit( val = numeric  )
-
-)->label( `Without leading Zeros`
-
-)->text(
+        )->content( `form`
+        )->title( `Input`
+        )->label( `Documentation`
+        )->link( text = `https://sapui5.hana.ondemand.com/sdk/#/api/sap.ui.model.odata.type.String%23methods/formatValue`
+                 href = `https://sapui5.hana.ondemand.com/sdk/#/api/sap.ui.model.odata.type.String%23methods/formatValue`
+        )->label( `Numeric`
+        )->input( value = client->_bind_edit( val = numeric )
+        )->label( `Without leading Zeros`
+        )->text(
     text = |\{path : `{ client->_bind_edit(
                             val  = numeric
                             path = abap_true ) }`, type : 'sap.ui.model.odata.type.String', constraints : \{  isDigitSequence : true \} \}| ).
diff --git a/docs/development/specific/geolocation.md b/docs/development/specific/geolocation.md
@@ -5,7 +5,7 @@ abap2UI5 includes a custom control for retrieving geolocation data from the user
 The control fires a `finished` event once the browser has determined the device position. All values are exchanged via two-way binding. See also `Z2UI5_CL_DEMO_APP_120`.
 
 ```abap
-CLASS z2ui5_cl_sample_geolocation DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_geolocation DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/development/specific/timer.md b/docs/development/specific/timer.md
@@ -16,7 +16,7 @@ The timer is added as a view element via `_z2ui5( )->timer( ... )` and supports
 Embed the timer in your view and control it via data binding. The following example increments a counter every 2 seconds:
 
 ```abap
-CLASS z2ui5_cl_sample_timer DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_timer DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
@@ -59,7 +59,7 @@ With `checkrepeat = abap_true`, the timer restarts automatically after each even
 If you only need the timer to fire once (e.g., to open a new browser tab), omit `checkrepeat` and control activation via `checkactive`:
 
 ```abap
-CLASS z2ui5_cl_sample_timer_once DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_sample_timer_once DEFINITION PUBLIC.
 
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
diff --git a/docs/technical/concept.md b/docs/technical/concept.md
@@ -195,7 +195,7 @@ In standard UI5 behavior, updating the XML View typically triggers a full re-ren
 Consider this example:
 
 ```abap
-CLASS z2ui5_cl_app_partial_rerendering DEFINITION PUBLIC CREATE PUBLIC.
+CLASS z2ui5_cl_app_partial_rerendering DEFINITION PUBLIC.
   PUBLIC SECTION.
     INTERFACES z2ui5_if_app.
     DATA text TYPE string.
diff --git a/docs/technical/dx.md b/docs/technical/dx.md
