这篇文章给大家介绍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屏左右才能显示完。这样一来,无论是读程序还是修改程序,都会有困难。因此建议把完成比较独立功能的程序块抽出,单独成为一个函数。把完成相同或相近功能的程序块抽出,独立为一个子函数。可以发现,越是上层的函数越简单,就是调用几个子函数,越是底层的函数完成的越是具体的工作。这是好程序的一个标志。这样,我们就可以在较上层函数里容易控制整个程序的逻辑,而在底层的函数里专注于某方面的功能的实现了。
关于Flex代码规范有哪些就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。