Discussion :

[xonop]

Bonjour,

Quelqu'un aurait-il un modèle de docstrings adapté à PyQt ?
J'ai bien regardé du côté des PEP, mais bon c'est assez succint.
J'avais l'habitude de faire des commentaires du style de ce qui se trouve en dessous, mais j'aimerai connaître les bonnes pratiques dans le domaine ...

Entête de script :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
#!/usr/bin/python
#----------------------------------------------------------------------------
# Nom: 
#
# Description: 
#
# Auteur: 
#
# Creation le: 
#----------------------------------------------------------------------------

Entête de classe :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
#----------------------------------------------------------------------------
# CLASSE      : 
# HERITAGE    : 
# DESCRIPTION : 
#----------------------------------------------------------------------------

Entête de constructeur :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
#------------------------------------------------------------------------
# CONSTRUCTEUR
# PARAMETRES : 
#------------------------------------------------------------------------

Entête de slot :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
#------------------------------------------------------------------------
# SLOT         : 
# OBJET SOURCE : 
# SIGNAL       : 
# DESCRIPTION  : 
# PARAMETRES   : 
#------------------------------------------------------------------------

Entête de méthode :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
#------------------------------------------------------------------------
# METHODE     : 
# DESCRIPTION : 
# PARAMETRES  : 
#------------------------------------------------------------------------

Entête de fonction :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
#------------------------------------------------------------------------
# FONCTION    : 
# DESCRIPTION : 
# PARAMETRES  : 
#------------------------------------------------------------------------