FCS阅读笔记:良好的编程习惯

转载 2004年10月30日 23:33:00
FCS阅读笔记:良好的编程习惯

作者:Liu21st  时间:2004-8-18  文档类型:转载  来自:Liu21st's Blog
浏览统计 year:3737 | Quarter:548 | Month:548 | Week:105 | today:14

spacer.gif

本节内容概述了在使用actionscript编程和创建应用程序的时候需要遵循的一些规则,以及如何使我们的程序代码更有效和具有更好的可读性,更方便调试应用程序。
把这节写在前面,也是为了让开始接触ActionScript编程的开发人员从一开始就养成好的编程和开发习惯。

1. 遵循命名规则

一个应用程序的命名规划必须保持一致性和可读性。任何一个实体的主要功能或用途必须能够根据命名明显的看出来。因为ActionScript是一个动态类型的语言,命名最好是包含有代表对象类型的后缀。一般而言,名词_动词和形容词_名词之类的语法是最常用的命名方式,如:
影片名字:my_movie.swf
URL实体:course_list_output
组件或对象名称:chat_mc
变量或属性:userName

方法和变量的名称应该以小写字母开头,对象和对象的构造方法应该大写。命名变量的时候使用大小写混和的方式,并且使用字母打头,还可以包含数字和下划线。
下面的一些命名是非法的:

_count =5 ;//首字符不能使用下划线
5count = 0;//首字符不能使用数字
foo/bar = true;//包含非法字符

另外,ActionScript使用的保留字不能用来命名变量。
ActionScript是基于ECMAScript,所以我们可以根据ECMAScript的规范来命名。如,
course_list_output = "foo"; //全部小写,使用下划线分割字串
courseListOutput = "foo"; // 大小写混和的方式
BASEURL = http://www.foo.com; // 常量使用全部大写
MAXCOUNTLIMIT = 10;
MyObject = function(){ }; // 构造函数
f = new MyObject(); // 对象
注意;良好的命名规范还可以使用Flash的代码提示功能。

2. 给你的代码添加注释

使用代码注释能够使得程序更清晰,也便于我们阅读。Flash支持的代码注释方法有两种:

 单行注释,通常用于变量的说明
var clicks = 0; // variable for number of button clicks
 多行注释,通常用于功能说明和大段文字的注释:
/*
Initialize the clicks variable that keeps track of the number of times
the button has been clicked.
*/

一些具有特定意思的注释方法:

// :TODO: topic
表明一个主题的开始
// :BUG: [bugid] topic
显示了一个BUG所在
// :KLUDGE:
表明下面的代码并不完善,可能存在问题
// :TRICKY:
告诉开发人员下面的代码具有相互作用,修改之前请谨慎

3. 保持代码的整体性

无论什么情况,应该尽可能保证所有代码在同一个位置,这样使得代码更容易搜索和调试。我们在调试程序的时候很大的困难就是定位代码,如果大部分代码都集中在同一帧,问题就比较好解决了。通常,我们把代码都放在第一帧中,并且单独放在最顶层。如果在第一帧中集中了大量的代码,记得用注释标记区分,并在开头加上代码说明。

//===========================================
// 视频语音聊天系统
// FCAVPresence组件
// Copyright ◎2002 Macromedia, Inc. All rights reserved.
// 完 善: Liu21st, Liu21st@126.com
//---------------------------------------------------------

在独立的功能模块前面加上类似的标注:
//===========================================
// 参数初始化
//---------------------------------------------------------

4. 初始化应用程序

记得一定要初始化你的应用程序,init函数应该是你的应用程序类的第一个函数,如果使用面向对象的编程方式则应该在构造函数中进线初始化工作。该函数只是对应用程序中的变量和对象初始化,其它的调用可以通过事件驱动。
下面的例子可以说明如何进线初始化

function FCAVPresenceClass() {
    this.init();
}
FCAVPresenceClass.prototype.init = function() {
    this.name = (this._name == null ? "_DEFAULT_" : this._name);
    this.prefix = "FCAVPresence." + this.name + ".";
};

5.使用局部变量

所有的局部变量使用关键字var来申明,这样可以避免被全局变量访问,更重要的是,可以保证变量不被覆盖和混淆程序逻辑。例如,下面的代码没有使用var来申明,覆盖了其它变量。

counter = 7;
function loopTest()
{
    trace(counter);
    for(counter = 0; counter < 5; counter++)
    {
        trace(counter);
    }
}
trace(counter);
loopTest();
trace(counter);

输出结果为:
7
7
0
1
2
3
4
5

6. 创建对象时使用原型添加方法和属性

当我们创建一个对象的时候,应当使用原型方式来添加对象的方法或属性,使得该方法或属性能够被所有该对象或子对象的实体所访问。这种能够确保内存中每个函数只有一份拷贝。作为一般的规则,不要在构造函数中定义方法。下面是一个正确的例子:

// Best practice for creating an object
MyObject = function()
{ }
MyObject.prototype.name = "";
MyObject.prototype.setName = function(name)
{
    this.name = name;
}
MyObject.prototype.getName = function()
{
    return this.name;
}

下面这段代码是不可取的:

// Less desirable practice for creating an object
MyObject = function()
{
    this.name = "";
    this.setName = function(name)
    {
        this.name = name;
    }
    this.getName = function()
    {
        return this.name;
    }
}

使用上面的方式在每个对象的实体被创建的时候都会实体重新复制每一个属性和方法,会加重系统的内存开销。

7. 规范命名方式获取代码提示功能

这方面我已经有过详细的叙述,请看:
[ actionscript代码提示功能 ]和 [ 面向对象方式的代码提示功能 ]

java良好的编程习惯

java良好的编程习惯 1.应该在每个程序的开始都加上注释,解释该程序的目的、作者以及程序最后一次被修改的日期和时间。 2.使用空行和空格来增强程序的可读性。 3.按照约定,类名标识...
  • javaniuniu
  • javaniuniu
  • 2017年05月29日 15:15
  • 517

养成良好的编程习惯(Java, python)

最开始用python 的时候一直觉得自己的代码没有别人的好看,很容易一个循环语句写的很长很长。看起来特别费劲。其原因就是一开始编写代码的时候没有很好的组织,数据结构不熟悉。常常想着“程序就跑一次,这样...
  • baidu_36316735
  • baidu_36316735
  • 2017年02月02日 23:47
  • 232

C语言的良好编程习惯

从编程菜鸟一路走来,慢慢对编程习惯有了一个新的认识。因为曾经我写的代码的可读性令自己也感到哭啼皆非,搞得自己晕头转向。今天特意来分享一下自己的一些关于编程习惯的心得。 很多人以为代码一敲完,能得到预期...
  • lbt111
  • lbt111
  • 2016年08月17日 18:45
  • 529

优秀程序员共有的7种优秀编程习惯

编程是一个很有趣、容易的事情,但是编写好的程序可能是一项艰巨的任务。在大多数情况下,我们发现自己绞尽脑汁,试图了解我们撰写的意大利面条代码,或者是因为新添加的次要功能而进行了大量更改,导致产生了很多糟...
  • m0_37934423
  • m0_37934423
  • 2017年08月11日 14:10
  • 139

C++编程好习惯

本文来自于朋友LJT的日常编程心得。1.不要在构造函数中做初始化操作 要求类(尤其是对外接口类)提供Init()函数,在该函数中进行相关初始化操作,初始化失败能够返回错误码。 可以规避问题: ...
  • fm0517
  • fm0517
  • 2016年08月10日 17:26
  • 587

Web前端应该有什么好习惯

Web前端应该有什么好习惯   前端是面向用户的,同时前端是面向设计师的。与设计师默契的相互配合,能最大限度的展现设计的水准,让用户满意,同时体现前端的价值。 好的工作习惯是对工作的体会,从一系...
  • papa_lu
  • papa_lu
  • 2015年02月10日 16:06
  • 737

【心得】要细心,思维要严谨,养成良好的代码习惯

今天写统计文件目录内的各种格式的文件个数,本来思路很简单的一个问题,结果写了,发现编译没错误,运行不起来,一直报各种空指针。 一直找一直找问题,搞了一晚上,这都一点半过了。最后才发现循环里面循环有个...
  • medtc
  • medtc
  • 2016年05月24日 00:45
  • 79

良好编程习惯

1.程序应该以注释开头,如时间,日期,用途,作者. 2.在逗号后插入空格,增强程序可读性. 3.在声明和执行语句间插入空行,以突出声明语句,程序更清晰. 4.在二元运算符两端都插入空...
  • oahsgnat
  • oahsgnat
  • 2014年10月17日 10:31
  • 287

良好的编程习惯

我们在编码的时候总是希望能写出风格良好,清晰、健壮的程序,把代码当成一件艺术品来看待、来雕琢,让coding成为一种艺术。 看了很多大牛关于编程风格与修养方面的文章,很受启发,结合自己体会,简录几条,...
  • mycinderella
  • mycinderella
  • 2007年08月05日 10:16
  • 296

良好的编程习惯(注释)

2.注释说明(一般情况下,源程序有效注释量必须在20%以上) (1). 说明性文件注释说明。 (如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:...
  • sillyboy1104
  • sillyboy1104
  • 2014年05月18日 20:11
  • 351
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:FCS阅读笔记:良好的编程习惯
举报原因:
原因补充:

(最多只允许输入30个字)