2020-12-23 14:59:06 +01:00
|
|
|
The multi-line comment syntax ``/* ... */`` should not be used for single line comments; the ``--`` syntax is more appropriate.
|
2020-06-30 12:48:07 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
== Noncompliant Code Example
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
/*
|
|
|
|
|
These comment lines are Compliant
|
|
|
|
|
comment 1
|
|
|
|
|
comment 2
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
This comment is also Compliant
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* This comment is Noncompliant */
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
== Compliant Solution
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
/*
|
|
|
|
|
These comment lines are Compliant
|
|
|
|
|
comment 1
|
|
|
|
|
comment 2
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
This comment is also Compliant
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
-- This comment is compliant
|
|
|
|
|
----
|
|
|
|
|
|
