vampire-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Vampire-devel] [Documentation] epydoc


From: Maxime Biais
Subject: [Vampire-devel] [Documentation] epydoc
Date: Fri, 19 Sep 2003 11:12:58 +0200

Hello,

Afin que la documentation vampire soit la plus homogène possible je vous
demande a TOUS (oui même toi petit breton sans frisette qui n'aime pas
le beurre salé et qui joue au KB football club) de documenter chacune de
vos méthodes, chacune de vos fonctions avec epydoc:

http://epydoc.sourceforge.net/epytext.html

En quoi ça consiste ?

Mettre des balises du genre @param, @return etc... partout pour tous les
arguments, et tout ce que l'on retourne. avec en bonus une phrase courte
de description de la méthodes.

exemple:

def create_var_dic(FinalTarball, FinalHost):
    """
    Create a dictionnary with all usefull variables hold in FinalTarball
    and FinalHost
    @param FinalTarball: FinalTarball Object
    @param FinalHost: FinalHost Object
    @return: a dictionary associating a variable and its value
    """
    res = {
        "HOSTNAME" : FinalHost.getName(),
        "TMPDIR" : FinalHost.getTmpDir()
        }
    if FinalTarball != None:
        vars = FinalTarball.getVars()
        for i in vars:
            res[i.upper()] = vars[i]
    return res

une exception cependant pour les accesseurs classiques (c'est à dire ceux
qui ne font aucun traitement mis à part "return self.machin" ou
"self.machin = truc") le nom est déjà assez explicite, préciser juste
"""accessor"""

pourquoi epydoc ? c'est le plus simple et il génère de la doc sous plein
de format sympathique. De plus en utilisant les balises epydoc, le
résultat vu avec pydoc est tout a fait lisible.

-- 
Maxime Biais




reply via email to

[Prev in Thread] Current Thread [Next in Thread]