Forums Développement Multimédia

Les formations Mediabox
Les formations Mediabox

Conventions d'écriture

Compatible ActionScript 2. Cliquer pour en savoir plus sur les compatibilités.

Il est important de suivre certaines normes d'écriture, pour que votre code puisse être facilement compris, relu et modifiable par d'autres personnes.

Noms des classes, méthodes et propriétés

Les class, variables et méthodes privées, publiques, statiques ou non, doivent pouvoir être clairement identifiées :

  • class : MyClass
  • public function : maMethode()
  • public function get : myProperty
  • public static function : maMethode()
  • public static var : CONSTANT
  • private : _privateProperty ou _privateMethod()
  • private static var : __privatePropertyStatic

Nom des variables

Il est d'usage de donner aux noms de variables leurs types ( notation hongroise ) :

  • a | Array
  • b | Boolean
  • cm | ContextMenu
  • cmi | ContextMenuItem
  • bt | Button
  • c | Color
  • d | Date
  • lv | LoadVars
  • mc | MovieClip
  • n | Number
  • o | Object
  • snd | Sound
  • s | String
  • t | TextField
  • tf | TextFormat
  • xml | XML
  • xmls | XMLSocket
  • cam | Camera
  • mic | Microphone
  • nc | NetConnection
  • ns | NetStream
  • vid | Video
  • lc | LocalConnection
  • mcl | MovieClipLoader
  • pj | PrintJob
  • rs | RecordSet
  • so | SharedObject

Pour les Composants :

  • cac | Accordian
  • ca | Alert
  • cbt | Button
  • cch | CheckBox
  • ccb | ComboBox
  • cdg | DataGrid
  • cdc | DateChooser
  • cdf | DateField
  • clbl | Label
  • cl | List
  • cld | Loader
  • cm | Menu
  • cmb | MenuBar
  • cns | NumericStepper
  • cpb | ProgressBar
  • crb | RadioButton
  • csp | ScrollPane
  • cta | TextArea
  • cti | TextInput
  • ctr | Tree
  • cw | Window

Si vous utilisez l'éditeur action-script intégré à flash ( déconseillé ), vous pouvez obtenir une coloration syntaxique de vos variables, en mettant en suffixe :

  • Array : _array
  • Button : _btn
  • Camera : _cam
  • Color : _color
  • ContextMenu : _cm
  • ContextMenuItem : _cmi
  • Date : _date
  • Error : _err
  • LoadVars : _lv
  • LocalConnection : _lc
  • Microphone : _mic
  • MovieClip : _mc
  • MovieClipLoader _mcl
  • PrintJob : _pj
  • NetConnection : _nc
  • NetStream : _ns
  • SharedObject : _so
  • Sound : _sound
  • String : _str
  • TextField : _txt
  • TextFormat : _fmt
  • Video : _video
  • XML : _xml
  • XMLNode : _xmlnode
  • XMLSocket : _xmlsocket