wiki:Documentation/T3Q/TOC

T3Q Documentation Outline

  1. Installation / Setup
  2. Using T3Q
    1. Configuration
    2. Command-Line Usage
    3. Output Format
    4. Performance and Memory Usage
  3. T3Q Quality Checks
    1. Naming Conventions
    1. Structure of Data
      1. Alphabetic Ordering of Types withing Groups
      2. Grouping of Ports and Related Messages
      3. No All Keyword in Port Type Definitions
    1. Log Statements
      1. Log Format Must Match the Format of a Regular Expression
      2. External Function Invocation Must Be Preceded By A Log Statement
      3. Inconclusive or Fail Setverdict Statement Must be Preceded by a Log …
    1. Code Style
      1. There Must Be No Labels or Goto Statements
      2. There Must Be No Nested Alt Statements
      3. There Must Be No Permutation Keyword
      4. There Must Be No AnyType Keyword
      5. There Must Be No Modified Template of a Modified Template
      6. Local Definitions Must Be Declared at the Beginning of Testcases, …
      7. Import Statements Must Be Declared at the Beginning of Modules
      8. There Must Be No Duplicated Identifiers On the Module Level
      9. There Must Be No Unused Definitions On the Module Level
      10. There Must Be No Inline Templates
      11. There Must Be No Over-specific Runs On Clauses
      12. There Must Be No Unused Imports
      13. There Must Be No Unused Formal Parameters
      14. There Must Be No Unused Local Definitions
      15. There Must Be No Uninitialised Local Variables
      16. There Must Be No Literals
    1. Test Suite Modularization: Module Containment
      1. TypesAndValues Module Must Contain Only Type and Constant Definitions
      2. Templates Module Must Contain Only Template Definitions
      3. Functions Module Must Contain Only Function and Altstep Definitions
      4. Testcases Module Must Contain Only Testcase and Function Definitions That …
      5. ModuleParams Module Must Contain Only Modulepar Definitions
      6. Interface Module Must Contain Only Component, Port, and Type Definitions
      7. TestSystem Module Must Contain Only Component and Port Definitions
      8. TestControl Module Must Contain Only Control Part Definition
    1. Test Suite Modularization: Importing Libraries
      1. TypesAndValues Modules Must Always Import From Certain Modules
      2. Testcases Module Must Always Import From Modules Prefixes with …
    1. Module Size
  11. T3Q Code Formatting Feature
  12. T3Q Misc Features
    1. List Imported Module Names
    2. List Imported File Names
    3. List Importing Module Names
    4. List Importing File Names

Last modified 14 years ago Last modified on 06/03/10 15:59:46