作者cjcat2266 (CJ Cat)
看板Flash
标题[讨论] AS通用命名习惯
时间Tue Mar 31 15:33:30 2009
好像没有人讨论过这个话题
那就来讨论一下呗 :p
很多人有自己的一套命名习惯
这没有一定的标准,只要自己、别人都容易理解就好了
但是有一套命名习惯是很多程式设计师都在用的
如果遵循这个命名习惯
自己写code就有一套命名标准,不会前後习惯不一
看使用同个命名习惯的人分享的code,也会看得很顺眼、理解迅速
命名习惯的好处,在於看到一个名字
就能够迅速判断这是变数、函式、常数、还是类别
以下所介绍的命名习惯为大多数AS和Java程式设计师所采用的
1.变数、属性(variable/property):
开头小写,之後每下一个单字就第一个字母大写
例如 myNumber, myBigNumber
每换一个单字就第一个字母大写的目的在於方便阅读
myBigNumber可以很清楚的分成"my big number"来念
若我写mybignumber,相信大家都需要顿一下才会念吧
如果是一个internal, protected,或private的属性,则以底线开头
後方再接正常的变数名称
例如 _myProtectedNumber, _myPrivateNumber
好处是自己在写code的时候可以辨认这个属性是否是public的
你可以对这些属性做一些"不安全但可增进效能"的存取
只要你保证这样的存取工能正确且不会出错就好
(其他人也不会用到,因为它不是public的)
另外如果不小心把这种应该只有自己写code才会动到的属性设成public
那使用者一旦看到有底线开头的属性可以用
就知道你可能有地方写错了,好心的人还会来提醒你
2.函式、方法(function/method):
同变数与属性
例如 myFunction, myOtherFunction, _myPrivateMethod
你可能会觉得这样会跟变数搞混
别担心,不要忘记函式後面还要接小括弧
所以你看到别人写这样的code
myThing = 1;
myOtherThing();
应该可以很明显看出哪个是变数,哪个是函式吧
(虽然AS有Function这个类别,不过就当成特例不要讨论吧)
4.类别(class):
同变数与函式,惟独第一个字母也要大写
从一些常见的AS内件类别命名可见一斑
Number, Boolean, DisplayObject, SoundChannel
3.常数(constant):
所有字母大写,单字之间补底线
例如以下常见的AS内建常数
Event.COMPLETE, Math.PI, Event.ENTER_FRAME, KeyboardEvent.KEY_DOWN
4.介面(interface):
同类别,只是前面再多一个大写的I
以下是一些AS常见的内建类别
IEventDispatcher, IBitmapDrawable
5.缩写(abbreviation):
缩写被视为是同一个"单字"
以HTML为例
变数名称 - myHtml, htmlText
类别名称 - HTMLHost, URIError
(类别使用缩写时,通常缩写只用在开头,然後全大写
修饰用的词(非缩写)也都会是放在缩写後面
所以一般是不会遇到缩写不是放在开头的情况
如URLLoader, MP3Player, SQLConnection)
P.S. 这种每换一个单字就第一个字母大写的样式叫做"骆驼式(camel style)"
因为一高一低的文字看起来像是骆驼的驼峰
以上是AS与Java常用的命名习惯的简介
希望可以帮助大家更有系统的命名,以及加速理解别人的code罗 :)
--
CJ Cat = Croa'J Cat = Cockroach Cat = 西街凯特 = 蜚蠊猫 = 蟑螂猫
Blog
http://cjcat.blogspot.com
Gallery
http://cjcat2266.deviantart.com
ptt2 Board CJWorkshop - 阿多比闪光(Adobe Flash)研讨区
--
※ 发信站: 批踢踢实业坊(ptt.cc)
◆ From: 61.228.85.107
※ 编辑: cjcat2266 来自: 61.228.85.107 (03/31 15:35)
1F:推 ufoufoufo:实用 04/02 23:57