Changes between Version 1 and Version 2 of Documentation/T3Q/Quality-Checks/Naming-Conventions

Timestamp:

10/06/10 09:55:21 (15 years ago)

Author:

phdmakk

Comment:

--

Documentation/T3Q/Quality-Checks/Naming-Conventions

@@ -3 +3 @@
  - '''Dependant Tags in XML Configuration''': namingConventionsConfig (the whole subsection)
 
-This quality check analyzes the identifiers for different entities (also in different contexts) and checks whether they comply to the supplied naming schemes. The naming schemes are defined as regular expressions in the "namingConventionsConfig" subsection in the T3Q configuration file. The basis for the naming conventions as well as the default values are taken from [[http://www.ttcn-3.org/NamingConventions.htm]]. The default settings in the "namingConventionsConfig" subsection are listed below. The fields are self-explanatory - they are formed following the schema "{languageElement}!RegExp", where the language elements are also taken from [[http://www.ttcn-3.org/NamingConventions.htm]] and ordered in the same way as on the web page.
+This quality check analyzes the identifiers for different entities (also in different contexts) and checks whether they comply to the supplied naming schemes. The naming schemes are defined as regular expressions in the "namingConventionsConfig" subsection in the T3Q configuration file. The basis for the naming conventions as well as the default values are taken from [[http://www.ttcn-3.org/NamingConventions.htm]]. The default settings in the "namingConventionsConfig" subsection are listed below. The fields are self-explanatory - they are formed following the schema "{languageElement}!RegExp", where the language elements are also taken from [[http://www.ttcn-3.org/NamingConventions.htm]] and ordered in the same way as on the web page. Blank naming rules will be ignored.
 
 {{{
@@ -40 +40 @@
 Note also that there are additional template restriction based naming conventions checks for templates. These reflect the STF160's notions of send and receive templates. Although the names may sound misleading, for these naming conventions the actual usage context (i.e. send or receive statements) for the templates in question is '''not''' taken into consideration. These rules are based on template restrictions in the definition of the templates, thus are also content-based. The rules according to which templates are classified as send or receive templates are as follows:
 
- 1. Templates defined with an ''omit'' or '''value''' restriction are considered send templates and shall conform to the naming convention. If such templates have formal template parameters, then these formal template parameters shall also be defined with the same (''omit'' or ''value'') template restrictions. If the formal template parameters are not defined with the appropriate template restrictions for this type of template (i.e. the template definition is defined inconsistently or ambiguously), an ''INFORMATION'' message will be provided informing of the occurrence, and the naming convention will not be checked for such occurrences.
+ 1. Templates defined with an '''omit''' or '''value''' restriction are considered send templates and shall conform to the naming convention. If such templates have formal template parameters, then these formal template parameters shall also be defined with the same (''omit'' or ''value'') template restrictions. If the formal template parameters are not defined with the appropriate template restrictions for this type of template (i.e. the template definition is defined inconsistently or ambiguously), an ''INFORMATION'' message will be provided informing of the occurrence, and the naming convention will not be checked for such occurrences.
  1. Templates defined without a restriction or with a ''present'' restriction are considered receive templates and shall conform to the naming convention. There is no restriction on the formal template parameters for such templates.