rspec/rules/S1917/rule.adoc
2021-01-27 13:42:22 +01:00

26 lines
468 B
Plaintext

Use either the ``++// ...++`` or ``++/* ... */++`` comment syntax, but be consistent and do not mix them within the same file.
== Noncompliant Code Example
----
/* Noncompliant; both comment syntaxes are used in the same file */
// Foo
/* Bar */
----
== Compliant Solution
----
// Compliant; uniform comment syntax
// Foo
// Bar
----
== See
* https://wiki.sei.cmu.edu/confluence/x/0zVGBQ[CERT, MSC55-J.] - Use comments consistently and in a readable fashion