ABAP Coding Guidelines

Detailed ABAP coding guidelines for development in this project.

For AI tools: Run abapgit-agent guide to read the full development guide, then use abapgit-agent ref --topic <name> to access individual guideline files below.

Coding Standards

Guide	Description
SQL Best Practices	Modern ABAP SQL syntax, joins, aggregations, host variables
Exception Handling	Class-based exceptions, TRY/CATCH patterns
Classes & Objects	OO patterns, instantiation, interfaces
Naming Conventions	Z/Y prefix rules, naming by object type
Documentation Comments	ABAP DOC shorttext, @parameter/@raising, CDS //, program *&—
Unit Testing	AUnit test structure, test doubles, assertions
Unit Testable Code	Dependency injection patterns for testable ABAP
CDS Views	CDS view entities, associations, annotations
CDS Testing	CDS test double framework (`CL_CDS_TEST_ENVIRONMENT`)
JSON Handling	`/ui2/cl_json` serialization and deserialization
abapGit XML Metadata	XML templates for classes, interfaces, tables, CDS views
Common ABAP Errors	Quick fixes for frequent activation and syntax errors

Debugging & Troubleshooting

Guide	Description
Debug Session Guide	Step-by-step debug workflow: set breakpoints, attach, inspect variables, pull flow architecture
Dump Analysis Guide	Analyse ST22 short dumps using the `dump` command
run Command Guide	Never-run-proactively rule, probe class workflow, scratchWorkspace setup

Workflow & Project Setup

Guide	Description
Object Creation Workflow	Decision diagram: customer vs SAP namespace, package assignment, probe vs PoC
Branch Workflow	Feature branch workflow with rebase-before-pull and PR creation
Development Workflow (Detailed)	Full workflow decision tree, error indicators, command reference
Object Creation	XML metadata templates and local class setup
Probe and PoC	Full decision flow for throwaway probe classes and persistent PoC objects

Table of contents