Abstract
Ce document décrit le modèle d'header de fichier introduit dans la version 2.1.
Vous allez apprendre à l'adapter et l'utiliser avec le goal update-file-header.
Modèle de header
Exemple
Voici un example de header de fichier (SANS inclusion dans un bloc commentaire) :
(1) # % L
(2) Description du projet
(3) %%
(4) Copyright (C) 2010 votre organization
(5) %%
(6) Contenu de la license
(7) # L %
- (1) Le tag de début de process, utilisé pour détecter le début du header (ne JAMAIS l'enlever).
- (2) Section de description du projet
- (3) Délimiteur de section
- (4) Section copyright (plus d'information ci-dessous)
- (5) Délimiteur de section
- (6) Section license
- (7) Le tag de fin de process, utilisé pour détecter la fin du header (ne JAMAIS l'enlever).
Configuration
Vous pouvez configurer :
- le tag de début de process
- le délimiteur de section
- le tag de fin de process
Modèle de copyright
La section de copyright doit être exactement de la forme :
Copyright (C) firstYear[ - lastYear] holder
Si firstYear et lastYear sont les même, lastYear peut être omis.
Bloc commentaire
Dans un fichier, nous devons obligatoirement placé le header de fichier dans un commentaire. Dans le fichier de description, vous pouvez l'adapter en choisissant un headerType.
Styles de commeantaire disponible
Voici la liste des styles de commentaire disponible. Vous pouvez les lister en utilisant le goal comment-style-list.
Ignorer un header
Si ne voulez pas que le goal update-file-header traite un fichier en particulier, vous pouvez utiliser un tag spécifique dans votre classe :
Note : Ne pas utiliser la balise de dépard (1) et de fin (7 dans l'exemple) Vous pouvez le changer avec la propriété ignoreTag.
