Changes between Version 11 and Version 12 of Documentation/T3Q/Quality-Checks/Code-Style

Timestamp:

12/10/24 17:35:42 (13 months ago)

Author:

phdmakk

Comment:

--

Documentation/T3Q/Quality-Checks/Code-Style

@@ -257 +257 @@
 
 This check makes sure there are no literals used, except in module parameters, template definitions, and constant definitions. Note that while in both module-level constants and local constants literals are permitted, in the case of templates, only template definitions at the module level can contain literals. Note also that currently matching symbols, boolean values, verdicts, omit-values, enumerated values, and address-values are not considered ''literals''. This may be a subject to change.
+
+
+==== There Must Be No ValueOf Operations for Values ====
+ * '''Symbolic Name in XML Configuration''': checkNoValueOfForValues
+ * '''Dependant Tags in XML Configuration''': -
+
+This check makes sure there are no '''valueof''' operations on "pure" values. This currently covers references to local variables and formal parameters.
+
+{{{
+        function f_Work() {
+                var float v_ToConvert := 2.0;
+                var float v_ValueCms;
+                var template float v_ToConvertTemplate := 2.0;
+                //Being a value already the call to valueof is redundant -> warning
+                v_ValueCms := f_ConvertInchesToCm(valueof(v_ToConvert));
+                //Should be ok -> no warning
+                v_ValueCms := f_ConvertInchesToCm(valueof(v_ToConvertTemplate)); 
+        }
+        //TODO: further examples with return values, parameters, etc
+
+        function f_Work (
+                float p_ToConvert,
+                template float p_ToConvertTemplate
+        )  return template float {
+                var float v_ValueCms;
+                //Being a value already the call to valueof is redundant -> warning
+                v_ValueCms := f_ConvertInchesToCm(valueof(p_ToConvert));
+                //Should be ok -> no warning  
+                v_ValueCms := f_ConvertInchesToCm(valueof(p_ToConvertTemplate)); 
+        }
+}}}