Coding Standards Template

Auteur
Affiliations

Emmanuel BRUNO

Université de Toulon

LIS UMR CNRS 7020

Date de publication

2026-10-03

Coding Standards

NoteTemplate Usage
  1. Define language-specific standards
  2. Set formatting rules
  3. Specify documentation requirements

Language Standards

[LANGUAGE]:
  formatter: "[TOOL]"
  linter: "[TOOL]"
  config_file: "[PATH]"
  
  naming:
    classes: "[PATTERN]"
    methods: "[PATTERN]"
    variables: "[PATTERN]"
    constants: "[PATTERN]"
    
  file_organization:
    max_length: [LINES]
    order: 
      - "[SECTION]"
      - "[SECTION]"

Code Quality Gates

metrics:
  complexity: [MAX]
  coverage: [PERCENTAGE]
  duplication: [PERCENTAGE]
  
analysis:
  tool: "[NAME]"
  rules: "[CONFIG_PATH]"

Documentation

### Function Documentation
/**
 * [DESCRIPTION]
 * @param {[TYPE]} [NAME] - [DESCRIPTION]
 * @returns {[TYPE]} [DESCRIPTION]
 */

Template Validation

Réutilisation