读AS3官方版FLEX SDK代码规范的摘录

原文地址：

http://opensource.adobe.com/wiki/display/flexsdk/Coding+Conventions

 

读此文章，总结出一些原则和规范，并记录下来，大家有兴趣的话也可以读读，如果错误或争议之处，请指出。多交流多进步。

 

1. 尽量避免使用缩写，名字长点没关系，最重要的是要让人看懂。当然在项目中约定的缩写是可以使用的，例如以下是flex sdk的一些缩写约定。

 

Avoid them as a general rule. For example, calculateOptimalValue() is a better method name than calcOptVal().

And if you don't abbreviate, developers won't have to remember whether you shortened a word like “qualified” to “qual” or “qlfd”.

However, we have standardized on a few abbreviations:

acc for accessibility, as in ButtonAccImpl
auto for automatic, as in autoLayout
auto for automatic, as in autoLayout
eval for evaluate, as in EvalBindingResponder
impl for implementation, as in ButtonAccImpl
info for information, as in GridRowInfo
num for number of, as in numChildren
min for minimum, as in minWidth
max for maximum, as in maxHeight
nav for navigation, as in NavBar
regexp for regular expression, as in RegExpValidator
util for utility, as in StringUtil

 

 

2. 对于只取首字母的缩写词，例如HTML，SWF，要么都大写，要么都小写， never Html or Swf。

 

Various acronyms are common in Flex, such as AIR, CSS, HLOC, IME, MX, MXML, RPC, RSL, SWF, UI, UID, URL, WSDL, and XML.

An acronym is always all-uppercase or all-lowercase (e.g., SWF or swf, but never Swf).

Examples of identifiers with acronyms are CSSStyleDeclaration, IUID, uid, IIME, and imeMode.

 

 

3. 对于指定了类型的名字，例如 一个具有border的 Shape，应该命名为 borderShape。再如，一个会shine的 button，因该命名为 shineButton。

 

 

4. Package Name，在flex项目里，表现为目录名，必须使用小写字母，而且只能使用名词或动名词。

 

Start them with a lowercase letter and use intercaps for subsequent words: controls, listClasses.

Package names should always be nouns or gerunds (the -ing noun form of a verb), not verbs, adjectives, or adverbs.

 

 

5. 文件名的命名：对于一些很重要的API来说， 文件名必须跟API的名字一致。include files 可不必。一般文件名要以大写字母开头，波浪写法。而一些资源文件则采用下划线方式： icon_align_left.png；

6.接口的命名必须以I作为开头

7. 类的命名： 第一个字母必须是大写，并采用波浪写法。以下是一些基于FLEX SDK的一些子类的命名方法，以供参考。

   一个原则： 修饰部分 +　名词。　修饰部分可以是动词、形容词或者是名词，可以是一个单词，也可以是多个，只要能够表达清楚就可以了。最后一个必须是名词。

Start them with an uppercase letter and use intercaps for subsequent words: Button, FocusManager, UIComponent.

Name Event subclasses FooBarEvent.

Name Error subclasses FooBarError.

Name the EffectInstance subclass associated with effect FooBar FooBarInstance.

Name Formatter subclasses FooBarFormatter.

Name Validator subclasses FooBarValidator.

Name skinning classes FooBarBackground, FooBarBorder, FooBarSkin, FooBarIcon, FooBarIndicator, FooBarSeparator, FooBarCursor, etc.

Name utility classes FooBarUtil (not FooBarUtils; the package is plural but the class is singular).

It is common to name a base class FooBarBase: ComboBase, DateBase, DataGridBase, ListBase.

 

 

 

分享到：

战争策略类Webgame的设计测试方法 | 程序员的素质是什么

• 2008-09-10 02:00
• 浏览 2821
• 评论(0)
• 查看更多