2023-05-03 11:06:20 +02:00
== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
2023-05-03 11:06:20 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2021-01-27 13:42:22 +01:00
With the default comment pattern ``++^'\s*\S+\s*$++``, which ignores single word comments:
2020-06-30 14:49:38 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 12:47:33 +02:00
----
Module Module1
Sub Main()
Console.WriteLine("Hello, world!") ' Noncompliant - My first program!
Console.WriteLine("Hello, world!") ' CompliantOneWord
End Sub
End Module
----
2023-05-03 11:06:20 +02:00
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 12:47:33 +02:00
----
Module Module1
Sub Main()
' Compliant - My first program!
Console.WriteLine("Hello, world!")
Console.WriteLine("Hello, world!") ' CompliantOneWord
End Sub
End Module
----
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
2023-05-25 14:18:12 +02:00
=== Parameters
.legalCommentPattern
****
----
^'\s*\S+\s*$
----
Pattern for text of trailing comments that are allowed.
****
2021-09-20 15:38:42 +02:00
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== on 7 Sep 2016, 17:55:47 Ann Campbell wrote:
\[~tamas.vajk] IMO we need to remove this exception (and possibly rename the parameter for clarity?)
=== on 9 Sep 2016, 08:13:09 Tamas Vajk wrote:
\[~ann.campbell.2] All the other languages have this exception, and the parameter name is also similar there. Why do you think we'd need to fix these issues?
include::../comments-and-links.adoc[]
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]