Re: [Squeak-fr] standard de présentation dans ofset ?

stéphane ducasse ducasse at iam.unibe.ch
Ven 12 Mai 06:41:39 UTC 2006


On 11 mai 06, at 23:44, Alain Plantec wrote:

> bonsoir,
>
> Il y a t-il quelque-part une description de normes à respecter pour  
> l'ecriture des doc squeak.
> par exemple :
> - utilisation du gras-italique-souligné
> - nommage des pages,
> - comment référencer une classe ou un mot clé dont on sait qu'un  
> jour il y aura une page dédiée
>  (euh... pas clair... par exemple :  j'écris dans ma doc  
> PluggableTextMorph, c'est le nom d'une classe et
>  on peut espérer qu'un beau jour, il y aura une page de référence  
> pour cette classe. J'utilise quoi ? [[PluggableTextMorph]] ou  
> encore [[Classe-PluggableTextMorph|PluggableTextMorph]] ....)
> - comment doit-on présenter le code d'une méthode :
> PluggableTextMorph>>update: aSymbol

toujours PluggableTextMorph>>update:
sinon le lecteur peut se perdre
>    ...
> ou
> update: aSymbol
>    ...
> la première solution est plus explicite, la seconde permet le  
> copier/coller.
> - comment nomme t-on un message (#update: ou update)
>
> merci
>
> alain
>
> _______________________________________________
> Squeak-fr mailing list
> Squeak-fr at lists.squeakfoundation.org
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/squeak-fr



More information about the Squeak-fr mailing list