Editing Naming and Coding Standards (section)

== 5. Paragraph Naming Conventions ==

This project uses a '''prefix-number naming scheme''' derived from IBM COBOL shop practice:

<span id="prefix-codes"></span>
=== 5.1 Prefix codes ===

{|
!width="33%"| Prefix
!width="33%"| Meaning
!width="33%"| Example
|-
| <code>r</code>
| Regular processing paragraph (business logic, I/O)
| <code>r80-test-number</code>
|-
| <code>s</code>
| System / infrastructure paragraph (DB connect, file open)
| <code>s00-connect</code>
|-
| <code>e</code>
| Error-handling paragraph
| <code>e10-handle-db-error</code>
|-
| <code>x</code>
| Exit / cleanup paragraph (always PERFORM last)
| <code>x99-shutdown</code>
|}

<blockquote>'''Observation from existing source:''' The project uses <code>r</code> and <code>s</code> prefixes already. The <code>e</code> and <code>x</code> prefixes are introduced here as an extension. The <code>r99</code> convention for shutdown paragraphs is retained.
</blockquote>
<span id="numbering"></span>
=== 5.2 Numbering ===

* Two-digit sequence: <code>00</code>, <code>10</code>, <code>20</code> … <code>90</code>, <code>99</code>.
* Low numbers (00–29): initialisation / setup.
* Mid numbers (30–79): main processing.
* High numbers (80–89): sub-processing / helpers.
* 90–98: cleanup and close.
* 99: final exit / stop.
* Leave gaps of 10 between paragraphs to allow insertion.

<span id="name-format"></span>
=== 5.3 Name format ===

<pre>&lt;prefix&gt;&lt;NN&gt;-&lt;short-hyphenated-description&gt;

Examples:
  r80-test-number
  r82-next-test-number
  r85-write-prime
  r89-get-next-divider
  r90-start-primes-report
  r99-close-primes
  s00-connect
  s01-cursor
  s02-fetch
  s99-disconnect</pre>
<span id="rules"></span>
=== 5.4 Rules ===

* Paragraph names must be unique within the program.
* A paragraph must do one thing. If it needs a comment explaining “also does X”, split it.
* Paragraphs called only from one place may be inlined (PERFORM vs inline code) — choose consistency over micro-optimisation.
* Never use <code>GO TO</code> except for the structured <code>GO TO &lt;paragraph&gt;</code> used as a skip (an accepted COBOL idiom). Do not use <code>ALTER</code>.


-----

<span id="procedure-division-coding-rules"></span>