rspec/rules/S1708/cfamily/rule.adoc

33 lines
646 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
{cpp} comments (``++//++``) require fewer keystrokes, and take less space. Perhaps most importantly, they do not have the nesting problems that C-style comments do. Therefore {cpp} comments are preferred.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,cpp]
2021-04-28 16:49:39 +02:00
----
/* this is my comment ... */
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,cpp]
2021-04-28 16:49:39 +02:00
----
// this is my comment ...
----
2021-04-28 16:49:39 +02:00
== Exceptions
Because a {cpp} header file may be included by a C source file, header files are ignored by this rule.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
endif::env-github,rspecator-view[]