
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
编程规范是每一位软件开发程序员需要熟练掌握并遵守的一个开发知识点,下面我们就通过案例分析来了解一下,编程规范都包含哪些内容。
一、源程序文件结构:
每个程序文件应由标题、内容和附加说明三部分组成。
(1)标题:文件前面的注释说明,其内容主要包括:程序名,作者,版权信息,简要说明等,必要时应有更详尽的说明(将以此部分以空行隔开单独注释)。
(2)内容控件注册等函数应放在内容部分的后,类的定义按private、protected、pubilic、__pubished的顺序,并尽量保持每一部分只有一个,各部分中按数据、函数、属性、事件的顺序。
(3)附加说明:文件末尾的补充说明,如参考资料等,若内容不多也可放在标题部分的后。
二、界面设计风格的一致性:
由于采用可视化编程,所有的界面均与Win32方式类似,相应采用的控件等也大都为Windows操作系统下的标准控件,而且参考了其他一些市面上相关的企业内部管理的应用软件。
基于简单易操作的原则,贴近用户考虑,用户界面采用Windows风格的标准界面,操作方式亦同Windows风格,这样在实施过程,可以降低对客户的培训,也可以使用户容易上手,简单易学。
三、编辑风格:
(1)缩进:缩进以Tab为单位,一个Tab为四个空格大小。全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。
(2)空格:数据和函数在其类型,修饰(如__fastcall等)名称之间适当空格并据情况对齐。关键字原则上空一格,不论是否有括号,对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。
(3)对齐:原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。
另每一行的长度不应超过屏幕太多,必要时适当换行。
(4)空行:程序文件结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行。
(5)注释:对注释有以下三点要求:
A、必须是有意义;
B、必须正确的描述了程序;
C、必须是新的。
注释必不可少,但也不应过多,以下是四种必要的注释:
标题、附加说明;
函数说明:对几乎每个函数都应有适当的说明,通常加在函数实现之前,在没有函数实现部分的情况下则加在函数原型前,其内容主要是函数的功能、目的、算法等说明,参数说明、返回值说明等,必要时还要有一些如特别的软硬件要求等说明;
在代码不明晰或不可移植处应有少量说明;
及少量的其它注释。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加danei0707学习了解。欢迎关注“达内在线”参与分销,赚更多好礼。