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.
40 lines
950 B
Plaintext
40 lines
950 B
Plaintext
== Why is this an issue?
|
|
|
|
The proper use of white space makes a major contribution to code readability.
|
|
|
|
|
|
This rule raises an issue when there is not a space character after the beginning and before the end of each comment (``++<!-- ... -->++``), directive (``++<%@ ... %>++``), and expression (``++<% ... %>++``).
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,html]
|
|
----
|
|
<!--Do the thing--> <!-- Noncompliant; missing space at beginning and end of text-->
|
|
<%@page import="java.io.*,java.util.*" %> <!-- Noncompliant; missing space at beginning -->
|
|
<% String title = "My Page";%> <!-- Noncompliant; missing space at end -->
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,html]
|
|
----
|
|
<!-- Do the thing -->
|
|
<%@ page import="java.io.*,java.util.*" %>
|
|
<% String title = "My Page"; %>
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Add a space at column X.
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|