Tutoriel : Conventions de nommage

Conventions de nommage

Généralité

Les noms de classes, des variables et des méthodes ne peuvent contenir que des caractères alphanumériques. Les nombres sont autorisés mais déconseillés dans la plupart des cas, à moins qu'ils appartiennent à un terme technique. Ne pas utiliser de soulignement, des traits d'union, ou tout autre caractère non alphanumérique.

Classes

 Par exemple:

 

MyCompany.useful_util.Debug_Toolbar est déconseillé
MyCompany.util.Base64 est acceptable

 

Les noms de classe doivent être regroupés en paquets. Au minimum, il devrait y avoir un espace de noms unique de haut niveau suivie par le nom de la classe. Par exemple:

 

MyCompany.data.CoolProxy
MyCompany.Application

 

Les espaces de noms de haut niveau et les noms de classe réel doivent être spécifié selon la convention CamelCased, tout le reste doit être en minuscule. Par exemple:

 

MyCompany.form.action.AutoLoad

 

 Les classes qui ne sont pas distribués par Sencha ne devrait jamais utiliser l'espace de noms Ext.

Les acronymes devraient également suivre la convention CamelCase énumérées ci-dessus. Par exemple:

 

Ext.data.JsonProxy au lieu de Ext.data.JSONProxy

MyCompany.util.HtmlParser au lieu de  MyCompary.parser.HTMLParser

MyCompany.server.Http au lieu de MyCompany.server.HTTP

Fichiers sources

Les noms des classes correspondent directement aux chemins de fichier dans lequel elles sont stockées. En conséquence, il doit y avoir qu'une seule classe par fichier. Par exemple:

 

Ext.util.Observable est stocké dans path/to/src/Ext/util/Observable.js
Ext.form.action.Submit est stocké dans path/to/src/Ext/form/action/Submit.js
MyCompany.chart.axis.Numeric est stocké dans path/to/src/MyCompany/chart/axis/Numeric.js

 

Où path/to/src est le répertoire de classes de votre application. Toutes les catégories devraient être à l'intérieur d'un répertoire, et devrait avoir un espace de noms pour un améliorer le développement, la maintenance et le déploiement.

Méthodes, variables et Propriétés

Les nom des Méthodes, des variables et des propriétés doivent toujours être en camelCase.

 

Nom de méthode acceptable:

 

encodeUsingMd5()
getHtml() à la place de getHTML()
getJsonResponse()à la place de getJSONResponse()
parseXmlContent()à la place de parseXMLContent()

 

Nom de variable acceptable:

 

var isGoodName

var base64Encoder

var xmlReader

var httpServer

Les CONSTANTES

Les constantes doivent être en majuscule.

 

Ext.MessageBox.YES = "Yes"

Ext.MessageBox.NO = "No"

MyCompany.alien.Math.PI = "4.13"