Chapitre 3.Documentation des modules

Table des matières
Introduction
Syntaxe des blocs de commentaires
Bloc des informations sur le module
Blocs d'informations sur les options et restrictions du module

Introduction

La distribution de Tablix inclut un système de documentation automatique spécialisée, similaire à Doxygen. mod-doc2.pl, un script Perl dans le répertoire doc, analyse le code source des modules d'ajustage de Tablix et génère un manuel de référence du module au format HTML. Ce script est suffisamment subtil pour déduire les informations suivantes directement du code source :

Les informations qui ne peuvent pas être déduites du code peuvent être fournies au système de documentation sous forme d'un ou plusieurs blocs de commentaires spécialement formatés. Ces blocs peuvent inclure des informations sur :

Note: Il n'est pas obligatoire d'inclure ces informations dans le code source du module. Le système de documentation créera toujours une page dans le manuel de référence pour le module, même s'il ne contient aucun bloc de commentaires. Toutefois, les modules qui doivent être inclus dans la distribution officielle de Tablix doivent inclure ces informations (documenter votre module est une bonne idée dans tous les cas).