Documenter vos codes

Lorsqu'on programme une chose importante est de bien documenter son code. Que cela soit pour vous, ou pour les personnes qui utiliseront votre code, ou passeront derrière vous. Tous les langages possède un système de documentation interne Perldoc, Javadoc, Pydoc etc... Par exemple en Python pour documenter une fonction nous utiliseront les triples quotes, tout de suite après sa définition.

def HelloWorld() :
    """ Une simple fonction qui affiche un message à l'écran """
    print "HelloWorld !\n"

La description sera donc disponible via la pydoc. En Perl nous avons le format Pod ((Plain Old documentation)) , la bonne vielle documentation. Pod est un lagage de balisage qui va permettre d'écrire de la documentation pour Perl, pour vos programmes Perl, ou encore pour vos modules Perl. Il sera ensuite possible de convertir POD dans différents formats notamment du texte brute, HTML, page de man. Je vous expliquerai dans un prochain article comment utiliser POD. Documentation POD sur enstimac