Flex代码规范详尽解读

开发 后端
Flex代码规范还是比较常用的,于是研究了一下Flex代码规范,这里拿来和大家简单分享一下,希望对你的学习有所帮助。

本文和大家重点讨论一下Flex代码规范,这是公司项目组成员在实际开发中总结的Flex代码规范,放在下面分享,欢迎大家一起学习。  

Flex代码规范

1.前言

1.1目的

  对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域,源程序的风格统一标志着可读性、可维护性、可重用性,是软件项目的一个重要组成部分。而目前还没有成文的编码风格文档,以至于很多时候,程序员没有一个共同的标准可以遵守,编码风格各异,程序可维护性差、可读性也很差。通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。

本文在参考业界已有的编码风格的基础上,描述了一个基于Flex的项目风格,力求一种统一的编程风格,并从整体编码风格、代码文件风格、函数编写风格、变量风格、注释风格等几个方面进行阐述。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性);
我们确信FlexSDK的代码不是一个人写出来的,而到做到如此的规范与统一,我们也一定可以做到更高的标准。

2.Flex代码规范的整体编码风格

2.1缩进

  缩进建议以4个空格为单位。Flex平台中已将tab键默认设置为4个空格处理。

2.2对齐

(参阅flex源代码格式)

2.3空行

(参阅Flex源代码格式)

2.4注释

  注释是软件可读性的具体体现。Flex代码规范中程序注释量一般占程序编码量的20%,软件工程要求不少于20%。程序注释不能用抽象的语言,类似于"处理"、"循环"这样的计算机抽象语言,要精确表达出程序的处理说明。例如:"计算净需求"、"计算***道工序的加工工时"等。避免每行程序都使用注释,可以在一段程序的前面加一段注释,具有明确的处理逻辑。
注释必不可少,但也不应过多,不要被动的为写注释而写注释。以下是四种必要的注释:
A.标题、附加说明。
B.函数、类等的说明。
(参阅flex源代码格式)
C.在代码不明晰或不可移植处必须有一定的说明。
D.及少量的其它注释,如自定义变量的注释、代码书写时间等。
注释有块注释和行注释两种,分别是指:"/**/"和"//"建议对A用块注释,D用行注释,B、C则视情况而定,但应统一,至少在一个单元中B类注释形式应统一。具体对不同文件、结构的注释会在后面详细说明。

2.5代码长度
……

2.6页宽

  Flex代码规范中页宽应该设置为80字符。源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进2个字符。

2.7行数

  一般的集成编程环境下,每屏大概只能显示不超过50行的程序,所以这个函数大概要5-6屏显示,在某些环境下要8屏左右才能显示完。这样一来,无论是读程序还是修改程序,都会有困难。因此建议把完成比较独立功能的程序块抽出,单独成为一个函数。把完成相同或相近功能的程序块抽出,独立为一个子函数。可以发现,越是上层的函数越简单,就是调用几个子函数,越是底层的函数完成的越是具体的工作。这是好程序的一个标志。这样,我们就可以在较上层函数里容易控制整个程序的逻辑,而在底层的函数里专注于某方面的功能的实现了。

 【编辑推荐】

  1. Flex代码格式化工具用法指南
  2. Flex代码格式化工具用法指南
  3. 浅析Flex代码格式化功能
  4. FlexBuilder3.0与Eclipse3.4的***结合
  5. Flex内存泄露解决方法和内存释放优化原则
责任编辑:佚名 来源: 9flex.com
相关推荐

2010-08-06 16:07:55

Flex通信

2010-08-12 09:19:31

Flex弹出窗口

2010-08-11 16:10:27

Flex DataGr

2010-08-06 11:04:06

Flex模块化

2010-08-04 10:04:52

Flex1.5环境配置

2010-07-29 11:20:49

Flex源代码

2010-07-19 16:25:06

Perl数组

2010-09-13 17:30:07

CSS优先级

2010-08-17 09:31:08

DIV布局

2010-06-22 10:01:40

Symbian开发

2010-08-03 11:06:46

Flex代码规范

2010-07-19 14:45:07

Perl进程控制函数

2010-08-03 10:09:09

Flex源代码

2010-07-09 14:51:13

UML类设计原则

2010-07-09 14:28:59

UML组成

2010-07-19 09:16:47

Perl包

2010-07-28 13:40:44

Flex数据绑定

2010-08-12 10:03:21

Flex性能优化

2010-07-29 17:00:36

Flex饼图

2020-05-25 11:14:59

代码程序开发
点赞
收藏

51CTO技术栈公众号