16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
45 lines
1.3 KiB
Plaintext
45 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Program/file names offer only very limited space for indicating program function, which is why you should take advantage of the ability to specify a program ``++TITLE++``. Omitting the ``++TITLE++`` statement will result in a default, uncommunicative ``++TITLE++`` value being printed at the top of each page of the source listing. Instead, you should write an expressive title that gives a clear impression of the program's function.
|
|
|
|
|
|
This rule raises an issue when a there is no ``++TITLE++`` before the ``++IDENTIFICATION DIVISION++``. Ideally, ``++TITLE++`` will be the first line of a program, but it cannot be placed before compiler options.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,cobol]
|
|
----
|
|
* Copyright (c) 2012 MyCo. All rights reserved. *> Noncompliant
|
|
IDENTIFICATION DIVISION.
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,cobol]
|
|
----
|
|
TITLE 'IntradayPosition.ExecutePostProcessing'
|
|
* Copyright (c) 2012 MyCo. All rights reserved.
|
|
IDENTIFICATION DIVISION.
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
* Add a title to this program.
|
|
* Move this title to the first line of the file.
|
|
|
|
|
|
=== Highlighting
|
|
|
|
``++TITLE++`` if it exists on the wrong line, otherwise file level issue
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|