Wikini

ModeleDeDescriptionDesMethodes

PagePrincipale :: DerniersChangements :: DerniersCommentaires :: ParametresUtilisateur :: Vous êtes ec2-54-226-175-101.compute-1.amazonaws.com

Modèle de description des méthodes

Pour décrire les différentes méthodes d'une classe (dans des pages séparées), je (LordFarquaad) propose le modèle suivant (inspiré de php.net):

On commence par un trail pour une navigation facile
{{trail toc="ClasseNomDeLaClasse"}}

Methode : NomDeLaMethode

(n'oubliez pas les guillemets doubles pour ne pas créer un lien, car votre méthode ne doit pas être détaillée dans la page NomDeLaMethode mais dans la page ClasseNomDeLaClasseMethodeNomDeLaMethode, par exemple ClasseWikiMethodeQuery)
ClasseNomDeLaClasse (lien vers la page de la classe concernée, par exemple ClasseWiki)
WikiNi "version de WikiNi à partir de laquelle la méthode est disponible" (exemple: "WikiNi >= 0.4.3")
Dépréciée depuis "version de WikiNi à partir de laquelle la méthode n'est plus utilisée" (le cas échéant) Par exemple: "Dépréciée depuis WikiNi 0.4.2 - ne l'utilisez pas ! Utilisez la méthode NomDeLaNouvelleMethode"
Résumé : copie du résumé placé à la page ClasseNomDeLaClasse

Description :

ReturnType NomDeLaMethode( [type NomArgument1 [, ...]] )
où vous remplacez ReturnType par le type de valeurs retournés ("void" si la méthode ne retourne aucune valeur) et type par le type d'argument à donner. Si plusieurs types sont possibles, utilisez "mixed". Vous pouvez mettre les arguments facultatifs entre crochets.

Description détaillée de la méthode et de son utilisation...

Voir aussi : noms des éventuelles méthodes, classes, fonctions et autres pages en rapport avec celle-ci.
On pourrait éventuellement mettre un {{backlinks}} aussi...

Un deuxième trail:
{{trail toc="ClasseNomDeLaClasse"}}

Suggestions de développement :

On parle ici des améliorations possibles pour la méthode en question: performances, fonctionnement, bugs etc.




Merci de garder la partie avant ces deux traits telle quelle, et de discuter de son amélioration ci-dessous.

Discussions concernant le modèle de description des méthodes

Je vois bien l'exemple de la page ClasseWikiMethodeLoadSingle : c'est vraiment très bien ! J'adhère à fond. Une petite remarque : il y a beaucoup de traits et 2 trails sont-ils vraiment indispensables ? Cf. mon exemple ExClasseWikiMethodeLoadSingle. -- CharlesNepote

Je voudrais surtout pas vous décourager de faire une si bonne documentation bien détaillée pour les développeurs, mais attention... Cette documentation il va falloir la maintenir ensuite ! Et je ne compte pas m'y coller... J'hésite déjà souvent à faire des développements vu que j'oublie à chaque fois les pages où je dois indiquer ce que j'ai fait... Si on en ajoute encore, je ne vais probablement plus développer du tout... :-( Merci au moins de respecter le modèle choisi pour la documentation qui impose d'indiquer dans le nom de page le numéro de version de WikiNi concerné. -- ProgFou
Il n'y a pas de commentaire sur cette page. [Afficher commentaires/formulaire]