Clean code conventions

The naming, structure and language-subset conventions that make source code readable across a team — and the question of which of them a checker can enforce.

Overview

The naming, structure and language-subset conventions that make ABAP readable across a team — and the question of which of them a checker can enforce.

SAP SHIPS
Standard ABAP →

code pal for ABAP — Cloud Edition The same Clean ABAP check set for ABAP Cloud, where the legacy edition cannot run.

code pal for ABAP ATC and Code Inspector checks for the parts of Clean ABAP a static analyser can actually check, installed into a system with [abapGit](artifact:abapgit-abapgit) rather than delivered with it.

ABAP Cloud →

code pal for ABAP — Cloud Edition The same Clean ABAP check set for ABAP Cloud, where the legacy edition cannot run.

SourceSAP/styleguides — Clean ABAPchecked
THE COMMUNITY ADDS

Refactoring help for old code: FORMfactor from Lars Hvam generates local classes with static methods from the FORM routines of an old program, for a developer to paste in by hand.

Artifacts4

4 of 4 artifacts
ArtifactSignals
Generators1
FORMfactorGenerates local classes from FORM-based ABAP programs
Signals
Quiet
Packages2
code pal for ABAPATC and Code Inspector checks for Clean ABAP
Signals
Functional boundary
code pal for ABAP — Cloud EditionClean ABAP check set for ABAP Cloud
Signals
none
Practices1
Clean ABAPOpen, versioned style guide for ABAP
Signals
none

Content1

Group by
Piece, what it offers
051: ABAP Cleaner in VS Code - Installation and Guide
Software-Heroes, Björn S., Blog

Details

Coverage
statecore and community, ABAP
assessed
relationshipunassessed
SourceSAP/styleguides — Clean ABAPchecked
For your agent
Ref
capability:abap-clean-code
JSON
/capabilities/abap-clean-code.json
MCP
Connecting an agent